Interface WritableStream

interface WritableStream {
    writable: boolean;
    addListener(event, listener): WritableStream;
    emit(event, ...args): boolean;
    end(cb?): void;
    end(data, cb?): void;
    end(str, encoding?, cb?): void;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount(type): number;
    listeners(event): Function[];
    off(event, listener): WritableStream;
    on(event, listener): WritableStream;
    once(event, listener): WritableStream;
    prependListener(event, listener): WritableStream;
    prependOnceListener(event, listener): WritableStream;
    rawListeners(event): Function[];
    removeAllListeners(event?): WritableStream;
    removeListener(event, listener): WritableStream;
    setMaxListeners(n): WritableStream;
    write(buffer, cb?): boolean;
    write(str, encoding?, cb?): boolean;
}

Hierarchy

Implemented by

Properties

writable

Methods

addListener emit end eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners write

Properties

writable

writable: boolean

Methods

addListener

  • addListener(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

emit

  • emit(event, ...args): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?): void

  • Parameters

    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns void

  • end(data, cb?): void

  • Parameters

    • data: string | Uint8Array
    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns void

  • end(str, encoding?, cb?): void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

on

  • on(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

once

  • once(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

prependListener

  • prependListener(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

prependOnceListener

  • prependOnceListener(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

rawListeners

  • rawListeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?): WritableStream

  • Parameters

    • Optional event: string | symbol

    Returns WritableStream

removeListener

  • removeListener(event, listener): WritableStream

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns WritableStream

setMaxListeners

  • setMaxListeners(n): WritableStream

  • Parameters

    • n: number

    Returns WritableStream

write

  • write(buffer, cb?): boolean

  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: ((err?) => void)
        • (err?): void

        • Parameters

          • Optional err: null | Error

          Returns void

    Returns boolean

  • write(str, encoding?, cb?): boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: ((err?) => void)
        • (err?): void

        • Parameters

          • Optional err: null | Error

          Returns void

    Returns boolean

Settings

Member Visibility

Theme

On This Page