Class ReadStream

_readableState

Readonlyclosed

destroyed

Readonlyerrored

readable

ReadonlyreadableAborted

ReadonlyreadableDidRead

ReadonlyreadableEncoding

ReadonlyreadableEnded

ReadonlyreadableFlowing

ReadonlyreadableHighWaterMark

ReadonlyreadableLength

ReadonlyreadableObjectMode

_destroy

• _destroy(error: null | Error, callback: (error?: null | Error) => void): void

• Parameters

  • error: null | Error
  • callback: (error?: null | Error) => void

  Returns void

_read

• _read(size: number): void

• Parameters

  • size: number

  Returns void

_undestroy

• _undestroy(): void

• Returns void

[asyncIterator]

• "[asyncIterator]"(): AsyncIterableIterator<any, any, any>

• Returns AsyncIterableIterator<any, any, any>

addListener

• addListener(event: "close", listener: () => void): this

• Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. readable
  5. error

  Parameters

  • event: "close"
  • listener: () => void

  Returns this
• addListener(event: "data", listener: (chunk: any) => void): this

• Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. readable
  5. error

  Parameters

  • event: "data"
  • listener: (chunk: any) => void

  Returns this
• addListener(event: "end", listener: () => void): this

• Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. readable
  5. error

  Parameters

  • event: "end"
  • listener: () => void

  Returns this
• addListener(event: "readable", listener: () => void): this

• Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. readable
  5. error

  Parameters

  • event: "readable"
  • listener: () => void

  Returns this
• addListener(event: "error", listener: (err: Error) => void): this

• Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. readable
  5. error

  Parameters

  • event: "error"
  • listener: (err: Error) => void

  Returns this
• addListener(event: string | symbol, listener: (...args: any[]) => void): this

• Event emitter The defined events on documents including:

  1. close
  2. data
  3. end
  4. readable
  5. error

  Parameters

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

  Returns this

asIndexedPairs

• asIndexedPairs(options?: SignalOption): Readable

• Parameters

  • Optionaloptions: SignalOption

  Returns Readable

compose

• compose<T extends ReadableStream>(
      stream:
          | T
          | ComposeFnParam
          | Iterable<T, any, any>
          | AsyncIterable<T, any, any>,
      options?: { signal: AbortSignal },
  ): T

• Type Parameters

  • T extends ReadableStream

  Parameters

  • stream: T | ComposeFnParam | Iterable<T, any, any> | AsyncIterable<T, any, any>
  • Optionaloptions: { signal: AbortSignal }

  Returns T

destroy

• destroy(error?: Error): this

• Parameters

  • Optionalerror: Error

  Returns this

drop

• drop(limit: number, options?: SignalOption): Readable

• Parameters

  • limit: number
  • Optionaloptions: SignalOption

  Returns Readable

emit

• emit(event: "close"): boolean

• Parameters

  • event: "close"

  Returns boolean

• emit(event: "data", chunk: any): boolean

• Parameters

  • event: "data"
  • chunk: any

  Returns boolean

• emit(event: "end"): boolean

• Parameters

  • event: "end"

  Returns boolean

• emit(event: "readable"): boolean

• Parameters

  • event: "readable"

  Returns boolean

• emit(event: "error", err: Error): boolean

• Parameters

  • event: "error"
  • err: Error

  Returns boolean

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

• Parameters

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

  Returns boolean

eventNames

• eventNames(): (string | symbol)[]

• Returns (string | symbol)[]

every

• every(
      fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
      options?: ArrayOptions,
  ): Promise<boolean>

• Parameters

  • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

  Returns Promise<boolean>

filter

• filter(
      fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
      options?: ArrayOptions,
  ): Readable

• Parameters

  • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

  Returns Readable

find

• find<T>(
      fn: (data: any, options?: SignalOption) => data is T,
      options?: ArrayOptions,
  ): Promise<undefined | T>

• Type Parameters

  • T

  Parameters

  • fn: (data: any, options?: SignalOption) => data is T
  • Optionaloptions: ArrayOptions

  Returns Promise<undefined | T>

• find(
      fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
      options?: ArrayOptions,
  ): Promise<any>

• Parameters

  • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

  Returns Promise<any>

flatMap

• flatMap(
      fn: (data: any, options?: SignalOption) => any,
      options?: ArrayOptions,
  ): Readable

• Parameters

  • fn: (data: any, options?: SignalOption) => any
  • Optionaloptions: ArrayOptions

  Returns Readable

forEach

• forEach(
      fn: (data: any, options?: SignalOption) => void | Promise<void>,
      options?: ArrayOptions,
  ): Promise<void>

• Parameters

  • fn: (data: any, options?: SignalOption) => void | Promise<void>
  • Optionaloptions: ArrayOptions

  Returns Promise<void>

getMaxListeners

• getMaxListeners(): number

• Returns number

isPaused

• isPaused(): boolean

• Returns boolean

iterator

• iterator(
      options?: { destroyOnReturn?: boolean },
  ): AsyncIterableIterator<any, any, any>

• Parameters

  • Optionaloptions: { destroyOnReturn?: boolean }

  Returns AsyncIterableIterator<any, any, any>

listenerCount

• listenerCount(eventName: string | symbol): number

• Parameters

  • eventName: string | symbol

  Returns number

listeners

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

• Parameters

  • eventName: string | symbol

  Returns Function[]

map

• map(
      fn: (data: any, options?: SignalOption) => any,
      options?: ArrayOptions,
  ): Readable

• Parameters

  • fn: (data: any, options?: SignalOption) => any
  • Optionaloptions: ArrayOptions

  Returns Readable

off

• off(eventName: string | symbol, listener: (...args: any[]) => void): this

• Parameters

  • eventName: string | symbol
  • listener: (...args: any[]) => void

  Returns this

on

• on(event: "close", listener: () => void): this

• Parameters

  • event: "close"
  • listener: () => void

  Returns this

• on(event: "data", listener: (chunk: any) => void): this

• Parameters

  • event: "data"
  • listener: (chunk: any) => void

  Returns this

• on(event: "end", listener: () => void): this

• Parameters

  • event: "end"
  • listener: () => void

  Returns this

• on(event: "readable", listener: () => void): this

• Parameters

  • event: "readable"
  • listener: () => void

  Returns this

• on(event: "error", listener: (err: Error) => void): this

• Parameters

  • event: "error"
  • listener: (err: Error) => void

  Returns this

• on(event: string | symbol, listener: (...args: any[]) => void): this

• Parameters

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

  Returns this

once

• once(event: "close", listener: () => void): this

• Parameters

  • event: "close"
  • listener: () => void

  Returns this

• once(event: "data", listener: (chunk: any) => void): this

• Parameters

  • event: "data"
  • listener: (chunk: any) => void

  Returns this

• once(event: "end", listener: () => void): this

• Parameters

  • event: "end"
  • listener: () => void

  Returns this

• once(event: "readable", listener: () => void): this

• Parameters

  • event: "readable"
  • listener: () => void

  Returns this

• once(event: "error", listener: (err: Error) => void): this

• Parameters

  • event: "error"
  • listener: (err: Error) => void

  Returns this

• once(event: string | symbol, listener: (...args: any[]) => void): this

• Parameters

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

  Returns this

pause

• pause(): this

• Returns this

pipe

• pipe<T extends _IWritable>(destination: T, options?: { end?: boolean }): T

• Type Parameters

  • T extends _IWritable

  Parameters

  • destination: T
  • Optionaloptions: { end?: boolean }

  Returns T

prependListener

• prependListener(event: "close", listener: () => void): this

• Parameters

  • event: "close"
  • listener: () => void

  Returns this

• prependListener(event: "data", listener: (chunk: any) => void): this

• Parameters

  • event: "data"
  • listener: (chunk: any) => void

  Returns this

• prependListener(event: "end", listener: () => void): this

• Parameters

  • event: "end"
  • listener: () => void

  Returns this

• prependListener(event: "readable", listener: () => void): this

• Parameters

  • event: "readable"
  • listener: () => void

  Returns this

• prependListener(event: "error", listener: (err: Error) => void): this

• Parameters

  • event: "error"
  • listener: (err: Error) => void

  Returns this

• prependListener(
      event: string | symbol,
      listener: (...args: any[]) => void,
  ): this

• Parameters

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

  Returns this

prependOnceListener

• prependOnceListener(event: "close", listener: () => void): this

• Parameters

  • event: "close"
  • listener: () => void

  Returns this

• prependOnceListener(event: "data", listener: (chunk: any) => void): this

• Parameters

  • event: "data"
  • listener: (chunk: any) => void

  Returns this

• prependOnceListener(event: "end", listener: () => void): this

• Parameters

  • event: "end"
  • listener: () => void

  Returns this

• prependOnceListener(event: "readable", listener: () => void): this

• Parameters

  • event: "readable"
  • listener: () => void

  Returns this

• prependOnceListener(event: "error", listener: (err: Error) => void): this

• Parameters

  • event: "error"
  • listener: (err: Error) => void

  Returns this

• prependOnceListener(
      event: string | symbol,
      listener: (...args: any[]) => void,
  ): this

• Parameters

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

  Returns this

push

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

• Parameters

  • chunk: any
  • Optionalencoding: string

  Returns boolean

rawListeners

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

• Parameters

  • eventName: string | symbol

  Returns Function[]

read

• read(size?: number): any

• Parameters

  • Optionalsize: number

  Returns any

reduce

• reduce<T = any>(
      fn: (
          previous: any,
          data: any,
          options?: Pick<ArrayOptions, "signal">,
      ) => T,
      initial?: undefined,
      options?: Pick<ArrayOptions, "signal">,
  ): Promise<T>

• Type Parameters

  • T = any

  Parameters

  • fn: (previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T
  • Optionalinitial: undefined
  • Optionaloptions: Pick<ArrayOptions, "signal">

  Returns Promise<T>

• reduce<T = any>(
      fn: (
          previous: T,
          data: any,
          options?: Pick<ArrayOptions, "signal">,
      ) => T,
      initial: T,
      options?: Pick<ArrayOptions, "signal">,
  ): Promise<T>

• Type Parameters

  • T = any

  Parameters

  • fn: (previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T
  • initial: T
  • Optionaloptions: Pick<ArrayOptions, "signal">

  Returns Promise<T>

removeAllListeners

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

• Parameters

  • Optionalevent: string | symbol

  Returns this

removeListener

• removeListener(event: "close", listener: () => void): this

• Parameters

  • event: "close"
  • listener: () => void

  Returns this

• removeListener(event: "data", listener: (chunk: any) => void): this

• Parameters

  • event: "data"
  • listener: (chunk: any) => void

  Returns this

• removeListener(event: "end", listener: () => void): this

• Parameters

  • event: "end"
  • listener: () => void

  Returns this

• removeListener(event: "readable", listener: () => void): this

• Parameters

  • event: "readable"
  • listener: () => void

  Returns this

• removeListener(event: "error", listener: (err: Error) => void): this

• Parameters

  • event: "error"
  • listener: (err: Error) => void

  Returns this

• removeListener(event: string | symbol, listener: (...args: any[]) => void): this

• Parameters

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

  Returns this

resume

• resume(): this

• Returns this

setEncoding

• setEncoding(encoding: string): this

• Parameters

  • encoding: string

  Returns this

setMaxListeners

• setMaxListeners(n: number): this

• Parameters

  • n: number

  Returns this

some

• some(
      fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
      options?: ArrayOptions,
  ): Promise<boolean>

• Parameters

  • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
  • Optionaloptions: ArrayOptions

  Returns Promise<boolean>

take

• take(limit: number, options?: SignalOption): Readable

• Parameters

  • limit: number
  • Optionaloptions: SignalOption

  Returns Readable

toArray

• toArray(options?: SignalOption): Promise<any[]>

• Parameters

  • Optionaloptions: SignalOption

  Returns Promise<any[]>

unpipe

• unpipe(destination?: Writable): this

• Parameters

  • Optionaldestination: Writable

  Returns this

unshift

• unshift(chunk: any): void

• Parameters

  • chunk: any

  Returns void