Class ReadStream

Hierarchy

Readable
- ReadStream

Implements

ReadStream

Constructors

constructor

new ReadStream(options?): ReadStream
Parameters
- Optionaloptions: ReadableOptions
Returns ReadStream
Inherited from Readable.constructor
- Defined in node_modules/@types/readable-stream/index.d.ts:418

Properties

_readableState

_readableState: ReadableState

[asyncDispose]

[asyncDispose]: never

bytesRead

bytesRead: number

The number of bytes that have been read so far.

Since

v6.4.0

`Readonly`closed

closed: boolean

destroyed

destroyed: boolean

`Readonly`errored

errored: null | Error

path

path: string | Buffer

The path to the file the stream is reading from as specified in the first argument to fs.createReadStream(). If path is passed as a string, thenreadStream.path will be a string. If path is passed as a Buffer, thenreadStream.path will be a Buffer. If fd is specified, thenreadStream.path will be undefined.

Since

v0.1.93

pending

pending: boolean

This property is true if the underlying file has not been opened yet, i.e. before the 'ready' event is emitted.

Since

v11.2.0, v10.16.0

readable

readable: boolean

`Readonly`readableAborted

readableAborted: never

`Readonly`readableDidRead

readableDidRead: never

`Readonly`readableEncoding

readableEncoding: never

`Readonly`readableEnded

readableEnded: never

`Readonly`readableFlowing

readableFlowing: null | boolean

`Readonly`readableHighWaterMark

readableHighWaterMark: number

`Readonly`readableLength

readableLength: number

`Readonly`readableObjectMode

readableObjectMode: never

Methods

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error?: null | Error) => void)
  - - (error?): void
    - Parameters
      Optionalerror: null | Error
      Returns void
Returns void
Implementation of Node.ReadStream._destroy
Inherited from Readable._destroy
- Defined in node_modules/@types/readable-stream/index.d.ts:146

_read

_read(size): void
Parameters
- size: number
Returns void
Implementation of Node.ReadStream._read
Inherited from Readable._read
- Defined in node_modules/@types/readable-stream/index.d.ts:105

_undestroy

_undestroy(): void
Returns void
Inherited from Readable._undestroy
- Defined in node_modules/@types/readable-stream/index.d.ts:227

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<any>
Returns AsyncIterableIterator<any>
Implementation of Node.ReadStream.[asyncIterator]
Inherited from Readable.[asyncIterator]
- Defined in node_modules/@types/readable-stream/index.d.ts:219

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
Implementation of Node.ReadStream.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/readable-stream/index.d.ts:158
addListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns this
Implementation of Node.ReadStream.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/readable-stream/index.d.ts:159
addListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/readable-stream/index.d.ts:160
addListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/readable-stream/index.d.ts:161
addListener(event, listener): this
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Node.ReadStream.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/readable-stream/index.d.ts:162
addListener(event, listener): this
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/readable-stream/index.d.ts:163

asIndexedPairs

asIndexedPairs(options?): Readable
Parameters
- Optionaloptions: SignalOption
Returns Readable
Implementation of Node.ReadStream.asIndexedPairs
Inherited from Readable.asIndexedPairs
- Defined in node_modules/@types/readable-stream/index.d.ts:135

close

close(callback?): void
Parameters
- callback: Callback = ...
Returns void
Implementation of Node.ReadStream.close
- Defined in src/emulation/streams.ts:7

compose

compose<T>(stream, options?): T
Type Parameters
- T extends ReadableStream
Parameters
- stream:
      | T
      | ComposeFnParam
      | Iterable<T>
      | AsyncIterable<T>
- Optionaloptions: {
  signal: AbortSignal;
  }
  - signal: AbortSignal
Returns T
Implementation of Node.ReadStream.compose
Inherited from Readable.compose
- Defined in node_modules/@types/readable-stream/index.d.ts:420

destroy

destroy(error?): this
Parameters
- Optionalerror: Error
Returns this
Implementation of Node.ReadStream.destroy
Inherited from Readable.destroy
- Defined in node_modules/@types/readable-stream/index.d.ts:147

drop

drop(limit, options?): Readable
Parameters
- limit: number
- Optionaloptions: SignalOption
Returns Readable
Implementation of Node.ReadStream.drop
Inherited from Readable.drop
- Defined in node_modules/@types/readable-stream/index.d.ts:133

emit

emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of Node.ReadStream.emit
Inherited from Readable.emit
- Defined in node_modules/@types/readable-stream/index.d.ts:165
emit(event, chunk): boolean
Parameters
- event: "data"
- chunk: any
Returns boolean
Implementation of Node.ReadStream.emit
Inherited from Readable.emit
- Defined in node_modules/@types/readable-stream/index.d.ts:166
emit(event): boolean
Parameters
- event: "end"
Returns boolean
Implementation of Node.ReadStream.emit
Inherited from Readable.emit
- Defined in node_modules/@types/readable-stream/index.d.ts:167
emit(event): boolean
Parameters
- event: "readable"
Returns boolean
Implementation of Node.ReadStream.emit
Inherited from Readable.emit
- Defined in node_modules/@types/readable-stream/index.d.ts:168
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of Node.ReadStream.emit
Inherited from Readable.emit
- Defined in node_modules/@types/readable-stream/index.d.ts:169
emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest...args: any[]
Returns boolean
Implementation of Node.ReadStream.emit
Inherited from Readable.emit
- Defined in node_modules/@types/readable-stream/index.d.ts:170

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of Node.ReadStream.eventNames
Inherited from Readable.eventNames
- Defined in node_modules/@types/readable-stream/index.d.ts:216

every

every(fn, options?): Promise<boolean>
Parameters
- fn: ((data: any, options?: SignalOption) => boolean | Promise<boolean>)
  - - (data, options?): boolean | Promise<boolean>
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns boolean | Promise<boolean>
- Optionaloptions: ArrayOptions
Returns Promise<boolean>
Implementation of Node.ReadStream.every
Inherited from Readable.every
- Defined in node_modules/@types/readable-stream/index.d.ts:128

filter

filter(fn, options?): Readable
Parameters
- fn: ((data: any, options?: SignalOption) => boolean | Promise<boolean>)
  - - (data, options?): boolean | Promise<boolean>
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns boolean | Promise<boolean>
- Optionaloptions: ArrayOptions
Returns Readable
Implementation of Node.ReadStream.filter
Inherited from Readable.filter
- Defined in node_modules/@types/readable-stream/index.d.ts:116

find

find<T>(fn, options?): Promise<undefined | T>
Type Parameters
- T
Parameters
- fn: ((data: any, options?: SignalOption) => data is T)
  - - (data, options?): data is T
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns data is T
- Optionaloptions: ArrayOptions
Returns Promise<undefined | T>
Implementation of Node.ReadStream.find
Inherited from Readable.find
- Defined in node_modules/@types/readable-stream/index.d.ts:126
find(fn, options?): Promise<any>
Parameters
- fn: ((data: any, options?: SignalOption) => boolean | Promise<boolean>)
  - - (data, options?): boolean | Promise<boolean>
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns boolean | Promise<boolean>
- Optionaloptions: ArrayOptions
Returns Promise<any>
Implementation of Node.ReadStream.find
Inherited from Readable.find
- Defined in node_modules/@types/readable-stream/index.d.ts:127

flatMap

flatMap(fn, options?): Readable
Parameters
- fn: ((data: any, options?: SignalOption) => any)
  - - (data, options?): any
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns any
- Optionaloptions: ArrayOptions
Returns Readable
Implementation of Node.ReadStream.flatMap
Inherited from Readable.flatMap
- Defined in node_modules/@types/readable-stream/index.d.ts:132

forEach

forEach(fn, options?): Promise<void>
Parameters
- fn: ((data: any, options?: SignalOption) => void | Promise<void>)
  - - (data, options?): void | Promise<void>
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns void | Promise<void>
- Optionaloptions: ArrayOptions
Returns Promise<void>
Implementation of Node.ReadStream.forEach
Inherited from Readable.forEach
- Defined in node_modules/@types/readable-stream/index.d.ts:120

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of Node.ReadStream.getMaxListeners
Inherited from Readable.getMaxListeners
- Defined in node_modules/@types/readable-stream/index.d.ts:210

isPaused

isPaused(): boolean
Returns boolean
Implementation of Node.ReadStream.isPaused
Inherited from Readable.isPaused
- Defined in node_modules/@types/readable-stream/index.d.ts:110

iterator

iterator(options?): AsyncIterableIterator<any>
Parameters
- Optionaloptions: {
  destroyOnReturn?: boolean;
  }
  - OptionaldestroyOnReturn?: boolean
Returns AsyncIterableIterator<any>
Implementation of Node.ReadStream.iterator
Inherited from Readable.iterator
- Defined in node_modules/@types/readable-stream/index.d.ts:218

listenerCount

listenerCount(eventName): number
Parameters
- eventName: string | symbol
Returns number
Implementation of Node.ReadStream.listenerCount
Inherited from Readable.listenerCount
- Defined in node_modules/@types/readable-stream/index.d.ts:215

listeners

listeners(eventName): Function[]
Parameters
- eventName: string | symbol
Returns Function[]
Implementation of Node.ReadStream.listeners
Inherited from Readable.listeners
- Defined in node_modules/@types/readable-stream/index.d.ts:212

map

map(fn, options?): Readable
Parameters
- fn: ((data: any, options?: SignalOption) => any)
  - - (data, options?): any
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns any
- Optionaloptions: ArrayOptions
Returns Readable
Implementation of Node.ReadStream.map
Inherited from Readable.map
- Defined in node_modules/@types/readable-stream/index.d.ts:115

off

off(eventName, listener): this
Parameters
- eventName: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.off
Inherited from Readable.off
- Defined in node_modules/@types/readable-stream/index.d.ts:208

on

on(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.on
Inherited from Readable.on
- Defined in node_modules/@types/readable-stream/index.d.ts:172
on(event, listener): this
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns this
Implementation of Node.ReadStream.on
Inherited from Readable.on
- Defined in node_modules/@types/readable-stream/index.d.ts:173
on(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.on
Inherited from Readable.on
- Defined in node_modules/@types/readable-stream/index.d.ts:174
on(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.on
Inherited from Readable.on
- Defined in node_modules/@types/readable-stream/index.d.ts:175
on(event, listener): this
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Node.ReadStream.on
Inherited from Readable.on
- Defined in node_modules/@types/readable-stream/index.d.ts:176
on(event, listener): this
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.on
Inherited from Readable.on
- Defined in node_modules/@types/readable-stream/index.d.ts:177

once

once(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.once
Inherited from Readable.once
- Defined in node_modules/@types/readable-stream/index.d.ts:179
once(event, listener): this
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns this
Implementation of Node.ReadStream.once
Inherited from Readable.once
- Defined in node_modules/@types/readable-stream/index.d.ts:180
once(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.once
Inherited from Readable.once
- Defined in node_modules/@types/readable-stream/index.d.ts:181
once(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.once
Inherited from Readable.once
- Defined in node_modules/@types/readable-stream/index.d.ts:182
once(event, listener): this
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Node.ReadStream.once
Inherited from Readable.once
- Defined in node_modules/@types/readable-stream/index.d.ts:183
once(event, listener): this
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.once
Inherited from Readable.once
- Defined in node_modules/@types/readable-stream/index.d.ts:184

pause

pause(): this
Returns this
Implementation of Node.ReadStream.pause
Inherited from Readable.pause
- Defined in node_modules/@types/readable-stream/index.d.ts:108

pipe

pipe<T>(destination, options?): T
Type Parameters
- T extends _IWritable
Parameters
- destination: T
- Optionaloptions: {
  end?: boolean;
  }
  - Optionalend?: boolean
Returns T
Implementation of Node.ReadStream.pipe
Inherited from Readable.pipe
- Defined in node_modules/@types/readable-stream/index.d.ts:419

prependListener

prependListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.prependListener
Inherited from Readable.prependListener
- Defined in node_modules/@types/readable-stream/index.d.ts:186
prependListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns this
Implementation of Node.ReadStream.prependListener
Inherited from Readable.prependListener
- Defined in node_modules/@types/readable-stream/index.d.ts:187
prependListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.prependListener
Inherited from Readable.prependListener
- Defined in node_modules/@types/readable-stream/index.d.ts:188
prependListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.prependListener
Inherited from Readable.prependListener
- Defined in node_modules/@types/readable-stream/index.d.ts:189
prependListener(event, listener): this
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Node.ReadStream.prependListener
Inherited from Readable.prependListener
- Defined in node_modules/@types/readable-stream/index.d.ts:190
prependListener(event, listener): this
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.prependListener
Inherited from Readable.prependListener
- Defined in node_modules/@types/readable-stream/index.d.ts:191

prependOnceListener

prependOnceListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.prependOnceListener
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/readable-stream/index.d.ts:193
prependOnceListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns this
Implementation of Node.ReadStream.prependOnceListener
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/readable-stream/index.d.ts:194
prependOnceListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.prependOnceListener
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/readable-stream/index.d.ts:195
prependOnceListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.prependOnceListener
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/readable-stream/index.d.ts:196
prependOnceListener(event, listener): this
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Node.ReadStream.prependOnceListener
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/readable-stream/index.d.ts:197
prependOnceListener(event, listener): this
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.prependOnceListener
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/readable-stream/index.d.ts:198

push

push(chunk, encoding?): boolean
Parameters
- chunk: any
- Optionalencoding: string
Returns boolean
Implementation of Node.ReadStream.push
Inherited from Readable.push
- Defined in node_modules/@types/readable-stream/index.d.ts:114

rawListeners

rawListeners(eventName): Function[]
Parameters
- eventName: string | symbol
Returns Function[]
Implementation of Node.ReadStream.rawListeners
Inherited from Readable.rawListeners
- Defined in node_modules/@types/readable-stream/index.d.ts:214

read

read(size?): any
Parameters
- Optionalsize: number
Returns any
Implementation of Node.ReadStream.read
Inherited from Readable.read
- Defined in node_modules/@types/readable-stream/index.d.ts:106

reduce

reduce<T>(fn, initial?, options?): Promise<T>
Type Parameters
- T = any
Parameters
- fn: ((previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T)
  - - (previous, data, options?): T
    - Parameters
      previous: any
      data: any
      Optionaloptions: Pick<ArrayOptions, "signal">
      Returns T
- Optionalinitial: undefined
- Optionaloptions: Pick<ArrayOptions, "signal">
Returns Promise<T>
Implementation of Node.ReadStream.reduce
Inherited from Readable.reduce
- Defined in node_modules/@types/readable-stream/index.d.ts:136
reduce<T>(fn, initial, options?): Promise<T>
Type Parameters
- T = any
Parameters
- fn: ((previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T)
  - - (previous, data, options?): T
    - Parameters
      previous: T
      data: any
      Optionaloptions: Pick<ArrayOptions, "signal">
      Returns T
- initial: T
- Optionaloptions: Pick<ArrayOptions, "signal">
Returns Promise<T>
Implementation of Node.ReadStream.reduce
Inherited from Readable.reduce
- Defined in node_modules/@types/readable-stream/index.d.ts:141

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent: string | symbol
Returns this
Implementation of Node.ReadStream.removeAllListeners
Inherited from Readable.removeAllListeners
- Defined in node_modules/@types/readable-stream/index.d.ts:207

removeListener

removeListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.removeListener
Inherited from Readable.removeListener
- Defined in node_modules/@types/readable-stream/index.d.ts:200
removeListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns this
Implementation of Node.ReadStream.removeListener
Inherited from Readable.removeListener
- Defined in node_modules/@types/readable-stream/index.d.ts:201
removeListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.removeListener
Inherited from Readable.removeListener
- Defined in node_modules/@types/readable-stream/index.d.ts:202
removeListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Node.ReadStream.removeListener
Inherited from Readable.removeListener
- Defined in node_modules/@types/readable-stream/index.d.ts:203
removeListener(event, listener): this
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Node.ReadStream.removeListener
Inherited from Readable.removeListener
- Defined in node_modules/@types/readable-stream/index.d.ts:204
removeListener(event, listener): this
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
Returns this
Implementation of Node.ReadStream.removeListener
Inherited from Readable.removeListener
- Defined in node_modules/@types/readable-stream/index.d.ts:205

resume

resume(): this
Returns this
Implementation of Node.ReadStream.resume
Inherited from Readable.resume
- Defined in node_modules/@types/readable-stream/index.d.ts:109

setEncoding

setEncoding(encoding): this
Parameters
- encoding: string
Returns this
Implementation of Node.ReadStream.setEncoding
Inherited from Readable.setEncoding
- Defined in node_modules/@types/readable-stream/index.d.ts:107

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Implementation of Node.ReadStream.setMaxListeners
Inherited from Readable.setMaxListeners
- Defined in node_modules/@types/readable-stream/index.d.ts:209

some

some(fn, options?): Promise<boolean>
Parameters
- fn: ((data: any, options?: SignalOption) => boolean | Promise<boolean>)
  - - (data, options?): boolean | Promise<boolean>
    - Parameters
      data: any
      Optionaloptions: SignalOption
      Returns boolean | Promise<boolean>
- Optionaloptions: ArrayOptions
Returns Promise<boolean>
Implementation of Node.ReadStream.some
Inherited from Readable.some
- Defined in node_modules/@types/readable-stream/index.d.ts:122

take

take(limit, options?): Readable
Parameters
- limit: number
- Optionaloptions: SignalOption
Returns Readable
Implementation of Node.ReadStream.take
Inherited from Readable.take
- Defined in node_modules/@types/readable-stream/index.d.ts:134

toArray

toArray(options?): Promise<any[]>
Parameters
- Optionaloptions: SignalOption
Returns Promise<any[]>
Implementation of Node.ReadStream.toArray
Inherited from Readable.toArray
- Defined in node_modules/@types/readable-stream/index.d.ts:121

unpipe

unpipe(destination?): this
Parameters
- Optionaldestination: Writable
Returns this
Implementation of Node.ReadStream.unpipe
Inherited from Readable.unpipe
- Defined in node_modules/@types/readable-stream/index.d.ts:111

unshift

unshift(chunk): void
Parameters
- chunk: any
Returns void
Implementation of Node.ReadStream.unshift
Inherited from Readable.unshift
- Defined in node_modules/@types/readable-stream/index.d.ts:112

wrap

wrap(oldStream): this
Parameters
- oldStream: Readable
Returns this
Implementation of Node.ReadStream.wrap
Inherited from Readable.wrap
- Defined in node_modules/@types/readable-stream/index.d.ts:113

Class ReadStream

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ReadStream

Properties

_readableState

[asyncDispose]

bytesRead

Since

Readonlyclosed

destroyed

Readonlyerrored

path

Since

pending

Since

readable

ReadonlyreadableAborted

ReadonlyreadableDidRead

ReadonlyreadableEncoding

ReadonlyreadableEnded

ReadonlyreadableFlowing

ReadonlyreadableHighWaterMark

ReadonlyreadableLength

ReadonlyreadableObjectMode

Methods

_destroy

Parameters

Parameters

Returns void

Returns void

_read

Parameters

Returns void

_undestroy

Returns void

[asyncIterator]

Returns AsyncIterableIterator<any>

addListener

Parameters

Returns void

Returns this

Parameters

Parameters

Returns void

Returns this

Parameters

Returns void

Returns this

Parameters

Returns void

Returns this

Parameters

Parameters

Returns void

Returns this

Parameters

Parameters

Returns void

Returns this

asIndexedPairs

Parameters

Returns Readable

close

Parameters

Returns void

compose

Type Parameters

Parameters

signal: AbortSignal

Returns T

destroy

Parameters

`Readonly`closed

`Readonly`errored

`Readonly`readableAborted

`Readonly`readableDidRead

`Readonly`readableEncoding

`Readonly`readableEnded

`Readonly`readableFlowing

`Readonly`readableHighWaterMark

`Readonly`readableLength

`Readonly`readableObjectMode

`Optional`destroyOnReturn?: boolean