Class Readable

Hierarchy

Stream
- Readable
  - Duplex

Implements

ReadableStream

Constructors

constructor

new Readable(opts?): Readable
Parameters
- Optional opts: ReadableOptions
Returns Readable
Overrides Stream.constructor
- Defined in node_modules/@types/node/stream.d.ts:36

Properties

destroyed

destroyed: boolean

readable

readable: boolean

`Readonly` readableEncoding

readableEncoding: null | BufferEncoding

`Readonly` readableEnded

readableEnded: boolean

`Readonly` readableFlowing

readableFlowing: null | boolean

`Readonly` readableHighWaterMark

readableHighWaterMark: number

`Readonly` readableLength

readableLength: number

`Readonly` readableObjectMode

readableObjectMode: boolean

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<any>
Returns AsyncIterableIterator<any>
Implementation of ReadableStream.[asyncIterator]
- Defined in node_modules/@types/node/stream.d.ts:124

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
- Defined in node_modules/@types/node/stream.d.ts:47

_read

_read(size): void
Parameters
- size: number
Returns void
- Defined in node_modules/@types/node/stream.d.ts:37

addListener

addListener(event, listener): Readable
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. error
5. pause
6. readable
7. resume
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
addListener(event, listener): Readable
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:62
addListener(event, listener): Readable
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:63
addListener(event, listener): Readable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:64
addListener(event, listener): Readable
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:65
addListener(event, listener): Readable
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:66
addListener(event, listener): Readable
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:67
addListener(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:68

destroy

destroy(error?): void
Parameters
- Optional error: Error
Returns void
- Defined in node_modules/@types/node/stream.d.ts:48

emit

emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:70
emit(event, chunk): boolean
Parameters
- event: "data"
- chunk: any
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:71
emit(event): boolean
Parameters
- event: "end"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:72
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:73
emit(event): boolean
Parameters
- event: "pause"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:74
emit(event): boolean
Parameters
- event: "readable"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:75
emit(event): boolean
Parameters
- event: "resume"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:76
emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:77

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of ReadableStream.eventNames
Inherited from Stream.eventNames
- Defined in node_modules/@types/node/globals.d.ts:584

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of ReadableStream.getMaxListeners
Inherited from Stream.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:576

isPaused

isPaused(): boolean
Returns boolean
Implementation of ReadableStream.isPaused
- Defined in node_modules/@types/node/stream.d.ts:42

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Implementation of ReadableStream.listenerCount
Inherited from Stream.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:580

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of ReadableStream.listeners
Inherited from Stream.listeners
- Defined in node_modules/@types/node/globals.d.ts:577

off

off(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of ReadableStream.off
Inherited from Stream.off
- Defined in node_modules/@types/node/globals.d.ts:573

on

on(event, listener): Readable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:79
on(event, listener): Readable
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:80
on(event, listener): Readable
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:81
on(event, listener): Readable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:82
on(event, listener): Readable
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:83
on(event, listener): Readable
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:84
on(event, listener): Readable
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:85
on(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:86

once

once(event, listener): Readable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:88
once(event, listener): Readable
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:89
once(event, listener): Readable
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:90
once(event, listener): Readable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:91
once(event, listener): Readable
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:92
once(event, listener): Readable
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:93
once(event, listener): Readable
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:94
once(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.once
Overrides Stream.once
- Defined in node_modules/@types/node/stream.d.ts:95

pause

pause(): Readable
Returns Readable
Implementation of ReadableStream.pause
- Defined in node_modules/@types/node/stream.d.ts:40

pipe

pipe<T>(destination, options?): T
Type Parameters
- T extends WritableStream
Parameters
- destination: T
- Optional options: {
  end?: boolean;
  }
  - Optional end?: boolean
Returns T
Implementation of ReadableStream.pipe
Inherited from Stream.pipe
- Defined in node_modules/@types/node/stream.d.ts:5

prependListener

prependListener(event, listener): Readable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:97
prependListener(event, listener): Readable
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:98
prependListener(event, listener): Readable
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:99
prependListener(event, listener): Readable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:100
prependListener(event, listener): Readable
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:101
prependListener(event, listener): Readable
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:102
prependListener(event, listener): Readable
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:103
prependListener(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:104

prependOnceListener

prependOnceListener(event, listener): Readable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:106
prependOnceListener(event, listener): Readable
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:107
prependOnceListener(event, listener): Readable
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:108
prependOnceListener(event, listener): Readable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:109
prependOnceListener(event, listener): Readable
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:110
prependOnceListener(event, listener): Readable
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:111
prependOnceListener(event, listener): Readable
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:112
prependOnceListener(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:113

push

push(chunk, encoding?): boolean
Parameters
- chunk: any
- Optional encoding: string
Returns boolean
- Defined in node_modules/@types/node/stream.d.ts:46

rawListeners

rawListeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of ReadableStream.rawListeners
Inherited from Stream.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:578

read

read(size?): any
Parameters
- Optional size: number
Returns any
Implementation of ReadableStream.read
- Defined in node_modules/@types/node/stream.d.ts:38

removeAllListeners

removeAllListeners(event?): Readable
Parameters
- Optional event: string | symbol
Returns Readable
Implementation of ReadableStream.removeAllListeners
Inherited from Stream.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:574

removeListener

removeListener(event, listener): Readable
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:115
removeListener(event, listener): Readable
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:116
removeListener(event, listener): Readable
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:117
removeListener(event, listener): Readable
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:118
removeListener(event, listener): Readable
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:119
removeListener(event, listener): Readable
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:120
removeListener(event, listener): Readable
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:121
removeListener(event, listener): Readable
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Readable
Implementation of NodeJS.ReadableStream.removeListener
Overrides Stream.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122

resume

resume(): Readable
Returns Readable
Implementation of ReadableStream.resume
- Defined in node_modules/@types/node/stream.d.ts:41

setEncoding

setEncoding(encoding): Readable
Parameters
- encoding: string
Returns Readable
Implementation of ReadableStream.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:39

setMaxListeners

setMaxListeners(n): Readable
Parameters
- n: number
Returns Readable
Implementation of ReadableStream.setMaxListeners
Inherited from Stream.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:575

unpipe

unpipe(destination?): Readable
Parameters
- Optional destination: WritableStream
Returns Readable
Implementation of ReadableStream.unpipe
- Defined in node_modules/@types/node/stream.d.ts:43

unshift

unshift(chunk, encoding?): void
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void
Implementation of ReadableStream.unshift
- Defined in node_modules/@types/node/stream.d.ts:44

wrap

wrap(oldStream): Readable
Parameters
- oldStream: ReadableStream
Returns Readable
Implementation of ReadableStream.wrap
- Defined in node_modules/@types/node/stream.d.ts:45

`Static` from

from(iterable, options?): Readable
A utility method for creating Readable Streams out of iterators.
Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable
- Defined in node_modules/@types/node/stream.d.ts:26

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
Inherited from Stream.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from Stream.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Stream.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from Stream.once
- Defined in node_modules/@types/node/events.d.ts:22

Class Readable

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: ReadableOptions

Returns Readable

Properties

destroyed

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

[asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: null | Error

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

_read

Parameters

size: number

Returns void

addListener

Parameters

event: "close"

listener: (() => void)

Returns void

Returns Readable

Parameters

event: "data"

listener: ((chunk) => void)

Parameters

chunk: any

Returns void

Returns Readable

Parameters

event: "end"

listener: (() => void)

Returns void

Returns Readable

Parameters

event: "error"

listener: ((err) => void)

Parameters

err: Error

Returns void

Returns Readable

Parameters

event: "pause"

listener: (() => void)

Returns void

Returns Readable

Parameters

event: "readable"

listener: (() => void)

Returns void

Returns Readable

Parameters

event: "resume"

listener: (() => void)

Returns void

Returns Readable

`Optional` opts: ReadableOptions

`Readonly` readableEncoding

`Readonly` readableEnded

`Readonly` readableFlowing

`Readonly` readableHighWaterMark

`Readonly` readableLength

`Readonly` readableObjectMode

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Optional` error: null | Error

`Rest` ...args: any[]

`Optional` error: Error

`Rest` ...args: any[]

`Rest` ...args: any[]