Interface ReadableStream

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

Hierarchy (view full)

Implemented by

Properties

readable

Methods

addListener emit eventNames getMaxListeners isPaused listenerCount listeners on once pause pipe prependListener prependOnceListener read removeAllListeners removeListener resume setEncoding setMaxListeners unpipe unshift wrap

Properties

readable

readable: 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

eventNames

getMaxListeners

isPaused

  • isPaused(): boolean

  • Returns boolean

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

pause

  • pause(): this

  • Returns this

pipe

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

  • Type Parameters

    Parameters

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

    Returns T

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

read

  • read(size?): string | Buffer

  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event, listener): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(): this

  • Returns this

setEncoding

  • setEncoding(encoding): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

unpipe

  • unpipe<T>(destination?): this

  • Type Parameters

    Parameters

    • Optional destination: T

    Returns this

unshift

  • unshift(chunk): void

  • Parameters

    • chunk: string

    Returns void

  • unshift(chunk): void

  • Parameters

    Returns void

wrap

Settings

Member Visibility

Theme

On This Page