Interface ReadWriteStream

interface ReadWriteStream {
    readable: boolean;
    writable: boolean;
    [asyncIterator](): AsyncIterableIterator<string | Buffer>;
    addListener(event, listener): ReadWriteStream;
    emit(event, ...args): boolean;
    end(cb?): void;
    end(data, cb?): void;
    end(str, encoding?, cb?): void;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    isPaused(): boolean;
    listenerCount(type): number;
    listeners(event): Function[];
    off(event, listener): ReadWriteStream;
    on(event, listener): ReadWriteStream;
    once(event, listener): ReadWriteStream;
    pause(): ReadWriteStream;
    pipe<T>(destination, options?): T;
    prependListener(event, listener): ReadWriteStream;
    prependOnceListener(event, listener): ReadWriteStream;
    rawListeners(event): Function[];
    read(size?): string | Buffer;
    removeAllListeners(event?): ReadWriteStream;
    removeListener(event, listener): ReadWriteStream;
    resume(): ReadWriteStream;
    setEncoding(encoding): ReadWriteStream;
    setMaxListeners(n): ReadWriteStream;
    unpipe(destination?): ReadWriteStream;
    unshift(chunk, encoding?): void;
    wrap(oldStream): ReadWriteStream;
    write(buffer, cb?): boolean;
    write(str, encoding?, cb?): boolean;
}

Hierarchy

Properties

readable writable

Methods

[asyncIterator] addListener emit end eventNames getMaxListeners isPaused listenerCount listeners off on once pause pipe prependListener prependOnceListener rawListeners read removeAllListeners removeListener resume setEncoding setMaxListeners unpipe unshift wrap write

Properties

readable

readable: boolean

writable

writable: boolean

Methods

[asyncIterator]

addListener

  • addListener(event, listener): ReadWriteStream

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ReadWriteStream

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

isPaused

  • isPaused(): boolean

  • Returns boolean

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event, listener): ReadWriteStream

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ReadWriteStream

on

  • on(event, listener): ReadWriteStream

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ReadWriteStream

once

  • once(event, listener): ReadWriteStream

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ReadWriteStream

pause

pipe

  • pipe<T>(destination, options?): T

  • Type Parameters

    Parameters

    • destination: T
    • Optional options: {
          end?: boolean;
      }
      • Optional end?: boolean

    Returns T

prependListener

prependOnceListener

rawListeners

  • rawListeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

read

  • read(size?): string | Buffer

  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

resume

setEncoding

setMaxListeners

unpipe

unshift

  • unshift(chunk, encoding?): void

  • Parameters

    Returns void

wrap

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