Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadStream

Hierarchy

Index

Properties

Methods

Properties

Optional isRaw

isRaw: undefined | false | true

Optional isTTY

isTTY: undefined | true

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

writable

writable: boolean

Methods

__@asyncIterator

_destroy

  • _destroy(err: Error | null, callback: function): void

  • Parameters

    • err: Error | null
    • callback: function
        • (err?: null | Error): void

        • Parameters

          • Optional err: null | Error

          Returns void

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

destroy

  • destroy(error?: Error): void

  • Parameters

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

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

    Returns boolean

end

  • end(cb?: undefined | function): void
  • end(data: string | Uint8Array, cb?: undefined | function): void
  • end(str: string, encoding?: undefined | string, cb?: undefined | function): void

  • Parameters

    • Optional cb: undefined | function

    Returns void

  • Parameters

    • data: string | Uint8Array
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

pause

  • pause(): this

  • Returns this

pipe

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

  • Type parameters

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

push

  • push(chunk: any, encoding?: undefined | string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string

    Returns boolean

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

read

  • read(size?: undefined | number): string | Buffer

  • Parameters

    • Optional size: undefined | number

    Returns string | Buffer

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(): this

  • Returns this

setEncoding

  • setEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

Optional setRawMode

  • setRawMode(mode: boolean): void

  • Parameters

    • mode: boolean

    Returns void

unpipe

unshift

  • unshift(chunk: string | Uint8Array, encoding?: BufferEncoding): void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Uint8Array | string, cb?: undefined | function): boolean
  • write(str: string, encoding?: undefined | string, cb?: undefined | function): boolean

  • Parameters

    • buffer: Uint8Array | string
    • Optional cb: undefined | function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns boolean

Generated using TypeDoc