Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReadStream

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

bytesRead

bytesRead: number

path

path: string | Buffer

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

_destroy

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

  • Parameters

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

        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "open", listener: function): this
  • addListener(event: "close", listener: function): this

  • events.EventEmitter

    1. open
    2. close

    Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (fd: number): void

        • Parameters

          • fd: number

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

close

  • close(): void

  • Returns void

destroy

  • destroy(error?: Error): void

  • Parameters

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): 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, listener: function): this
  • on(event: "open", listener: function): this
  • on(event: "close", listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (fd: number): void

        • Parameters

          • fd: number

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "open", listener: function): this
  • once(event: "close", listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (fd: number): void

        • Parameters

          • fd: number

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

pause

  • pause(): 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, listener: function): this
  • prependListener(event: "open", listener: function): this
  • prependListener(event: "close", listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (fd: number): void

        • Parameters

          • fd: number

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "open", listener: function): this
  • prependOnceListener(event: "close", listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (fd: number): void

        • Parameters

          • fd: number

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • 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[]

read

  • read(size?: undefined | number): any

  • Parameters

    • Optional size: undefined | number

    Returns any

removeAllListeners

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

removeListener

  • removeListener(event: "close", listener: function): this
  • removeListener(event: "data", listener: function): this
  • removeListener(event: "end", listener: function): this
  • removeListener(event: "readable", listener: function): this
  • removeListener(event: "error", listener: function): this
  • removeListener(event: string | symbol, listener: function): this

resume

  • resume(): this

setEncoding

  • setEncoding(encoding: string): this

setMaxListeners

  • setMaxListeners(n: number): this

unpipe

unshift

  • Parameters

    Returns void

wrap

Static from

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc