Class ReadStream

constructor

• new ReadStream(options?): ReadStream

• Parameters

  • Optional options: ReadableOptions

  Returns ReadStream

_readableState

Readonly closed

destroyed

Readonly errored

readable

Readonly readableAborted

Readonly readableDidRead

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<any>

• Returns AsyncIterableIterator<any>

_destroy

• _destroy(error, callback): void

• Parameters

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

      • Parameters

        • Optional error: null | Error

        Returns void

  Returns void

_read

• _read(size): void

• Parameters

  • size: number

  Returns void

_undestroy

• _undestroy(): void

• Returns void

addListener

• addListener(event, listener): this

• Event emitter The defined events on documents including:

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

  Parameters

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

      • Returns void

  Returns this
• addListener(event, listener): this

• Parameters

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

      • Parameters

        • chunk: any

        Returns void

  Returns this

• addListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• addListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• addListener(event, listener): this

• Parameters

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

      • Parameters

        • err: Error

        Returns void

  Returns this

• addListener(event, listener): this

• Parameters

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

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this

asIndexedPairs

• asIndexedPairs(options?): Readable

• Parameters

  • Optional options: SignalOption

  Returns Readable

compose

• compose<T>(stream, options?): T

• Type Parameters

  • T extends ReadableStream

  Parameters

  • stream: T | ComposeFnParam | Iterable<T> | AsyncIterable<T>
  • Optional options: {
        signal: AbortSignal;
    }

    • signal: AbortSignal

  Returns T

destroy

• destroy(error?): this

• Parameters

  • Optional error: Error

  Returns this

drop

• drop(limit, options?): Readable

• Parameters

  • limit: number
  • Optional options: SignalOption

  Returns Readable

emit

• emit(event): boolean

• Parameters

  • event: "close"

  Returns boolean

• emit(event, chunk): boolean

• Parameters

  • event: "data"
  • chunk: any

  Returns boolean

• emit(event): boolean

• Parameters

  • event: "end"

  Returns boolean

• emit(event): boolean

• Parameters

  • event: "readable"

  Returns boolean

• emit(event, err): boolean

• Parameters

  • event: "error"
  • err: Error

  Returns boolean

• emit(event, ...args): boolean

• Parameters

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

  Returns boolean

eventNames

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

• Returns (string | symbol)[]

every

• every(fn, options?): Promise<boolean>

• Parameters

  • fn: ((data, options?) => boolean | Promise<boolean>)
    • • (data, options?): boolean | Promise<boolean>

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns boolean | Promise<boolean>

  • Optional options: ArrayOptions

  Returns Promise<boolean>

filter

• filter(fn, options?): Readable

• Parameters

  • fn: ((data, options?) => boolean | Promise<boolean>)
    • • (data, options?): boolean | Promise<boolean>

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns boolean | Promise<boolean>

  • Optional options: ArrayOptions

  Returns Readable

find

• find<T>(fn, options?): Promise<undefined | T>

• Type Parameters

  • T

  Parameters

  • fn: ((data, options?) => data is T)
    • • (data, options?): data is T

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns data is T

  • Optional options: ArrayOptions

  Returns Promise<undefined | T>

• find(fn, options?): Promise<any>

• Parameters

  • fn: ((data, options?) => boolean | Promise<boolean>)
    • • (data, options?): boolean | Promise<boolean>

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns boolean | Promise<boolean>

  • Optional options: ArrayOptions

  Returns Promise<any>

flatMap

• flatMap(fn, options?): Readable

• Parameters

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

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns any

  • Optional options: ArrayOptions

  Returns Readable

forEach

• forEach(fn, options?): Promise<void>

• Parameters

  • fn: ((data, options?) => void | Promise<void>)
    • • (data, options?): void | Promise<void>

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns void | Promise<void>

  • Optional options: ArrayOptions

  Returns Promise<void>

getMaxListeners

• getMaxListeners(): number

• Returns number

isPaused

• isPaused(): boolean

• Returns boolean

iterator

• iterator(options?): AsyncIterableIterator<any>

• Parameters

  • Optional options: {
        destroyOnReturn?: boolean;
    }

    • Optional destroyOnReturn?: boolean

  Returns AsyncIterableIterator<any>

listenerCount

• listenerCount(eventName): number

• Parameters

  • eventName: string | symbol

  Returns number

listeners

• listeners(eventName): Function[]

• Parameters

  • eventName: string | symbol

  Returns Function[]

map

• map(fn, options?): Readable

• Parameters

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

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns any

  • Optional options: ArrayOptions

  Returns Readable

off

• off(eventName, listener): this

• Parameters

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

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this

on

• on(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• on(event, listener): this

• Parameters

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

      • Parameters

        • chunk: any

        Returns void

  Returns this

• on(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• on(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• on(event, listener): this

• Parameters

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

      • Parameters

        • err: Error

        Returns void

  Returns this

• 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: "close"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

• once(event, listener): this

• Parameters

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

      • Parameters

        • chunk: any

        Returns void

  Returns this

• once(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• once(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• once(event, listener): this

• Parameters

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

      • Parameters

        • err: Error

        Returns void

  Returns this

• 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

  • T extends _IWritable

  Parameters

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

    • Optional end?: boolean

  Returns T

prependListener

• prependListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• prependListener(event, listener): this

• Parameters

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

      • Parameters

        • chunk: any

        Returns void

  Returns this

• prependListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• prependListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• prependListener(event, listener): this

• Parameters

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

      • Parameters

        • err: Error

        Returns void

  Returns this

• 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: "close"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

• prependOnceListener(event, listener): this

• Parameters

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

      • Parameters

        • chunk: any

        Returns void

  Returns this

• prependOnceListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• prependOnceListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• prependOnceListener(event, listener): this

• Parameters

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

      • Parameters

        • err: Error

        Returns void

  Returns this

• prependOnceListener(event, listener): this

• Parameters

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

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this

push

• push(chunk, encoding?): boolean

• Parameters

  • chunk: any
  • Optional encoding: string

  Returns boolean

rawListeners

• rawListeners(eventName): Function[]

• Parameters

  • eventName: string | symbol

  Returns Function[]

read

• read(size?): any

• Parameters

  • Optional size: number

  Returns any

reduce

• reduce<T>(fn, initial?, options?): Promise<T>

• Type Parameters

  • T = any

  Parameters

  • fn: ((previous, data, options?) => T)
    • • (previous, data, options?): T

      • Parameters

        • previous: any
        • data: any
        • Optional options: Pick<ArrayOptions, "signal">

        Returns T

  • Optional initial: undefined
  • Optional options: Pick<ArrayOptions, "signal">

  Returns Promise<T>

• reduce<T>(fn, initial, options?): Promise<T>

• Type Parameters

  • T = any

  Parameters

  • fn: ((previous, data, options?) => T)
    • • (previous, data, options?): T

      • Parameters

        • previous: T
        • data: any
        • Optional options: Pick<ArrayOptions, "signal">

        Returns T

  • initial: T
  • Optional options: Pick<ArrayOptions, "signal">

  Returns Promise<T>

removeAllListeners

• removeAllListeners(event?): this

• Parameters

  • Optional event: string | symbol

  Returns this

removeListener

• removeListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• removeListener(event, listener): this

• Parameters

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

      • Parameters

        • chunk: any

        Returns void

  Returns this

• removeListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• removeListener(event, listener): this

• Parameters

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

      • Returns void

  Returns this

• removeListener(event, listener): this

• Parameters

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

      • Parameters

        • err: Error

        Returns void

  Returns this

• 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

• setMaxListeners(n): this

• Parameters

  • n: number

  Returns this

some

• some(fn, options?): Promise<boolean>

• Parameters

  • fn: ((data, options?) => boolean | Promise<boolean>)
    • • (data, options?): boolean | Promise<boolean>

      • Parameters

        • data: any
        • Optional options: SignalOption

        Returns boolean | Promise<boolean>

  • Optional options: ArrayOptions

  Returns Promise<boolean>

take

• take(limit, options?): Readable

• Parameters

  • limit: number
  • Optional options: SignalOption

  Returns Readable

toArray

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

• Parameters

  • Optional options: SignalOption

  Returns Promise<any[]>

unpipe

• unpipe(destination?): this

• Parameters

  • Optional destination: Writable

  Returns this

unshift

• unshift(chunk): void

• Parameters

  • chunk: any

  Returns void

wrap

• wrap(oldStream): this

• Parameters

  • oldStream: Readable

  Returns this