Class Duplex

Hierarchy

Readable
- Duplex
  - Socket
  - Transform

Implements

Writable

Constructors

constructor

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

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

`Readonly` writable

writable: boolean

`Readonly` writableCorked

writableCorked: number

`Readonly` writableEnded

writableEnded: boolean

`Readonly` writableFinished

writableFinished: boolean

`Readonly` writableHighWaterMark

writableHighWaterMark: number

`Readonly` writableLength

writableLength: number

`Readonly` writableObjectMode

writableObjectMode: 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>
Inherited from Readable.[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
      error: null | Error
      Returns void
Returns void
Implementation of Writable._destroy
Overrides Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:257

_final

_final(callback): void
Parameters
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Implementation of Writable._final
- Defined in node_modules/@types/node/stream.d.ts:258

_read

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

_write

_write(chunk, encoding, callback): void
Parameters
- chunk: any
- encoding: string
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Implementation of Writable._write
- Defined in node_modules/@types/node/stream.d.ts:255

`Optional` _writev

_writev(chunks, callback): void
Parameters
- chunks: {
  chunk: any;
  encoding: string;
  }[]
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Implementation of Writable._writev
- Defined in node_modules/@types/node/stream.d.ts:256

addListener

addListener(event, listener): Duplex
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 Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
addListener(event, listener): Duplex
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: any
      Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:62
addListener(event, listener): Duplex
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:63
addListener(event, listener): Duplex
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:64
addListener(event, listener): Duplex
Parameters
- event: "pause"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:65
addListener(event, listener): Duplex
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:66
addListener(event, listener): Duplex
Parameters
- event: "resume"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:67
addListener(event, listener): Duplex
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Duplex
Implementation of Writable.addListener
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:68

cork

cork(): void
Returns void
Implementation of Writable.cork
- Defined in node_modules/@types/node/stream.d.ts:265

destroy

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

emit

emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:70
emit(event, chunk): boolean
Parameters
- event: "data"
- chunk: any
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:71
emit(event): boolean
Parameters
- event: "end"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:72
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:73
emit(event): boolean
Parameters
- event: "pause"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:74
emit(event): boolean
Parameters
- event: "readable"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:75
emit(event): boolean
Parameters
- event: "resume"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.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 Writable.emit
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:77

end

end(cb?): void
Parameters
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of Writable.end
- Defined in node_modules/@types/node/stream.d.ts:262
end(chunk, cb?): void
Parameters
- chunk: any
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of Writable.end
- Defined in node_modules/@types/node/stream.d.ts:263
end(chunk, encoding?, cb?): void
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of Writable.end
- Defined in node_modules/@types/node/stream.d.ts:264

eventNames

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

getMaxListeners

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

isPaused

isPaused(): boolean
Returns boolean
Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:42

listenerCount

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

listeners

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

off

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

on

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

once

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

pause

pause(): Duplex
Returns Duplex
Inherited from Readable.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 Writable.pipe
Inherited from Readable.pipe
- Defined in node_modules/@types/node/stream.d.ts:5

prependListener

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

prependOnceListener

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

push

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

rawListeners

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

read

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

removeAllListeners

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

removeListener

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

resume

resume(): Duplex
Returns Duplex
Inherited from Readable.resume
- Defined in node_modules/@types/node/stream.d.ts:41

setDefaultEncoding

setDefaultEncoding(encoding): Duplex
Parameters
- encoding: string
Returns Duplex
Implementation of Writable.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:261

setEncoding

setEncoding(encoding): Duplex
Parameters
- encoding: string
Returns Duplex
Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:39

setMaxListeners

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

uncork

uncork(): void
Returns void
Implementation of Writable.uncork
- Defined in node_modules/@types/node/stream.d.ts:266

unpipe

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

unshift

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

wrap

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

write

write(chunk, encoding?, cb?): boolean
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: ((error) => void)
  - - (error): void
    - Parameters
      error: undefined | null | Error
      Returns void
Returns boolean
Implementation of Writable.write
- Defined in node_modules/@types/node/stream.d.ts:259
write(chunk, cb?): boolean
Parameters
- chunk: any
- Optional cb: ((error) => void)
  - - (error): void
    - Parameters
      error: undefined | null | Error
      Returns void
Returns boolean
Implementation of Writable.write
- Defined in node_modules/@types/node/stream.d.ts:260

`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
Inherited from Readable.from
- 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 Readable.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 Readable.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 Readable.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 Readable.once
- Defined in node_modules/@types/node/events.d.ts:22

Class Duplex

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: DuplexOptions

Returns Duplex

Properties

destroyed

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

Readonly writable

Readonly writableCorked

Readonly writableEnded

Readonly writableFinished

Readonly writableHighWaterMark

Readonly writableLength

Readonly writableObjectMode

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

[asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: null | Error

callback: ((error) => void)

Parameters

error: null | Error

Returns void

Returns void

_final

Parameters

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

_read

Parameters

size: number

Returns void

_write

Parameters

chunk: any

encoding: string

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

Optional _writev

Parameters

chunks: { chunk: any; encoding: string; }[]

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

addListener

Parameters

event: "close"

listener: (() => void)

Returns void

Returns Duplex

Parameters

event: "data"

listener: ((chunk) => void)

`Optional` opts: DuplexOptions

`Readonly` readableEncoding

`Readonly` readableEnded

`Readonly` readableFlowing

`Readonly` readableHighWaterMark

`Readonly` readableLength

`Readonly` readableObjectMode

`Readonly` writable

`Readonly` writableCorked

`Readonly` writableEnded

`Readonly` writableFinished

`Readonly` writableHighWaterMark

`Readonly` writableLength

`Readonly` writableObjectMode

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Optional` error: null | Error

`Optional` error: null | Error

`Optional` _writev

chunks: {
chunk: any;
encoding: string;
}[]

`Optional` error: null | Error

`Rest` ...args: any[]

`Optional` error: Error