Readable

Hierarchy

<internal>.Stream
- Readable

Implements

<internal>.ReadableStream

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

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

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

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

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from Stream.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

off

off(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

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

removeAllListeners

removeAllListeners(event?: string | symbol): <internal>.Readable

Implementation of ReadableStream.removeAllListeners
Inherited from Stream.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns <internal>.Readable

setMaxListeners

setMaxListeners(n: number): <internal>.Readable

Implementation of ReadableStream.setMaxListeners
Inherited from Stream.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns <internal>.Readable

getMaxListeners

getMaxListeners(): number

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

listeners

listeners(event: string | symbol): Function[]

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

rawListeners

rawListeners(event: string | symbol): Function[]

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

listenerCount

listenerCount(type: string | symbol): number

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

eventNames

eventNames(): (string | symbol)[]

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

pipe

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

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

Static from

from(iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>, options?: <internal>.ReadableOptions): <internal>.Readable

- Defined in node_modules/@types/node/stream.d.ts:24
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>
- Optional options: <internal>.ReadableOptions
Returns <internal>.Readable

_read

_read(size: number): void

- Defined in node_modules/@types/node/stream.d.ts:35
Parameters
- size: number
Returns void

read

read(size?: number): any

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

setEncoding

setEncoding(encoding: string): <internal>.Readable

Implementation of ReadableStream.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:37
Parameters
- encoding: string
Returns <internal>.Readable

pause

pause(): <internal>.Readable

Implementation of ReadableStream.pause
- Defined in node_modules/@types/node/stream.d.ts:38
Returns <internal>.Readable

resume

resume(): <internal>.Readable

Implementation of ReadableStream.resume
- Defined in node_modules/@types/node/stream.d.ts:39
Returns <internal>.Readable

isPaused

isPaused(): boolean

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

unpipe

unpipe(destination?: <internal>.WritableStream): <internal>.Readable

Implementation of ReadableStream.unpipe
- Defined in node_modules/@types/node/stream.d.ts:41
Parameters
- Optional destination: <internal>.WritableStream
Returns <internal>.Readable

unshift

unshift(chunk: any, encoding?: <internal>.BufferEncoding): void

Implementation of ReadableStream.unshift
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- chunk: any
- Optional encoding: <internal>.BufferEncoding
Returns void

wrap

wrap(oldStream: <internal>.ReadableStream): <internal>.Readable

Implementation of ReadableStream.wrap
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- oldStream: <internal>.ReadableStream
Returns <internal>.Readable

push

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

- Defined in node_modules/@types/node/stream.d.ts:44
Parameters
- chunk: any
- Optional encoding: string
Returns boolean

_destroy

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

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

destroy

destroy(error?: Error): <internal>.Readable

- Defined in node_modules/@types/node/stream.d.ts:46
Parameters
- Optional error: Error
Returns <internal>.Readable

addListener

addListener(event: "close", listener: (() => void)): <internal>.Readable
addListener(event: "data", listener: ((chunk: any) => void)): <internal>.Readable
addListener(event: "end", listener: (() => void)): <internal>.Readable
addListener(event: "readable", listener: (() => void)): <internal>.Readable
addListener(event: "error", listener: ((err: Error) => void)): <internal>.Readable
addListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

Implementation of ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:57
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 <internal>.Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:58
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:59
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:60
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.addListener
Overrides Stream.addListener
- Defined in node_modules/@types/node/stream.d.ts:62
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Readable

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

Implementation of ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:64
Parameters
- event: "close"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:65
Parameters
- event: "data"
- chunk: any
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:66
Parameters
- event: "end"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:67
Parameters
- event: "readable"
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:68
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of NodeJS.ReadableStream.emit
Overrides Stream.emit
- Defined in node_modules/@types/node/stream.d.ts:69
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

on

on(event: "close", listener: (() => void)): <internal>.Readable
on(event: "data", listener: ((chunk: any) => void)): <internal>.Readable
on(event: "end", listener: (() => void)): <internal>.Readable
on(event: "readable", listener: (() => void)): <internal>.Readable
on(event: "error", listener: ((err: Error) => void)): <internal>.Readable
on(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

Implementation of ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.on
Overrides Stream.on
- Defined in node_modules/@types/node/stream.d.ts:76
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Readable

once

once(event: "close", listener: (() => void)): <internal>.Readable
once(event: "data", listener: ((chunk: any) => void)): <internal>.Readable
once(event: "end", listener: (() => void)): <internal>.Readable
once(event: "readable", listener: (() => void)): <internal>.Readable
once(event: "error", listener: ((err: Error) => void)): <internal>.Readable
once(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

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

prependListener

prependListener(event: "close", listener: (() => void)): <internal>.Readable
prependListener(event: "data", listener: ((chunk: any) => void)): <internal>.Readable
prependListener(event: "end", listener: (() => void)): <internal>.Readable
prependListener(event: "readable", listener: (() => void)): <internal>.Readable
prependListener(event: "error", listener: ((err: Error) => void)): <internal>.Readable
prependListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

Implementation of ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:85
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:87
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:89
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependListener
Overrides Stream.prependListener
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Readable

prependOnceListener

prependOnceListener(event: "close", listener: (() => void)): <internal>.Readable
prependOnceListener(event: "data", listener: ((chunk: any) => void)): <internal>.Readable
prependOnceListener(event: "end", listener: (() => void)): <internal>.Readable
prependOnceListener(event: "readable", listener: (() => void)): <internal>.Readable
prependOnceListener(event: "error", listener: ((err: Error) => void)): <internal>.Readable
prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

Implementation of ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:93
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:94
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:96
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.Readable
Implementation of NodeJS.ReadableStream.prependOnceListener
Overrides Stream.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.Readable

removeListener

removeListener(event: "close", listener: (() => void)): <internal>.Readable
removeListener(event: "data", listener: ((chunk: any) => void)): <internal>.Readable
removeListener(event: "end", listener: (() => void)): <internal>.Readable
removeListener(event: "readable", listener: (() => void)): <internal>.Readable
removeListener(event: "error", listener: ((err: Error) => void)): <internal>.Readable
removeListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.Readable

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

[asyncIterator]

[asyncIterator](): <internal>.AsyncIterableIterator<any>

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

Properties

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.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

readable: boolean

Readonly readableEncoding

readableEncoding: <internal>.BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

destroyed

destroyed: boolean

Constructors

constructor

new Readable(opts?: <internal>.ReadableOptions): <internal>.Readable

Overrides Stream.constructor
- Defined in node_modules/@types/node/stream.d.ts:34
Parameters
- Optional opts: <internal>.ReadableOptions
Returns <internal>.Readable

Hierarchy

Implements

Index

Methods

Properties

Constructors

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

off

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.Readable

removeAllListeners

Parameters

Optional event: string | symbol

Returns <internal>.Readable

setMaxListeners

Parameters

n: number

Returns <internal>.Readable

getMaxListeners

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

rawListeners

Parameters

event: string | symbol

Returns Function[]

listenerCount

Parameters

type: string | symbol

Returns number

eventNames

Returns (string | symbol)[]

pipe

Type Parameters

T extends <internal>.WritableStream<T>

Parameters

destination: T

Optional options: { end?: boolean }

Optional end?: boolean

Returns T

Static from

Parameters

iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>

Optional options: <internal>.ReadableOptions

Returns <internal>.Readable

_read

Parameters

size: number

Returns void

read

Parameters

Optional size: number

Returns any

setEncoding