Interface WritableStream

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

Hierarchy (view full)

Implemented by

Properties

writable

Methods

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

Properties

writable

writable: boolean

Methods

addListener

  • addListener(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

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

  • Parameters

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

    Returns boolean

end

  • end(cb?): void

  • Parameters

    • Optional cb: Function

    Returns void

  • end(buffer, cb?): void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • end(str, cb?): void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

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

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

eventNames

getMaxListeners

listenerCount

listeners

  • listeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeAllListeners

removeListener

  • removeListener(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

write

  • write(buffer, cb?): boolean

  • Parameters

    • buffer: string | Buffer
    • Optional cb: Function

    Returns boolean

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

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Settings

Member Visibility

Theme

On This Page