Class Duplex

Hierarchy (view full)

Readable
- Duplex
  - Socket
  - internal.Transform

Implements

internal.Writable

Constructors

constructor

new Duplex(opts?): Duplex
Parameters
- Optional opts: internal.DuplexOptions
Returns Duplex
Overrides Readable.constructor

Properties

readable

readable: boolean

`Readonly` readableHighWaterMark

readableHighWaterMark: number

writable

writable: boolean

`Readonly` writableHighWaterMark

writableHighWaterMark: number

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

_destroy(error, callback): void
Parameters
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: Error
      Returns void
Returns void
Implementation of Writable._destroy
Overrides Readable._destroy

_final

_final(callback): void
Parameters
- callback: Function
Returns void
Implementation of Writable._final

_read

_read(size): void
Parameters
- size: number
Returns void
Inherited from Readable._read

_write

_write(chunk, encoding, callback): void
Parameters
- chunk: any
- encoding: string
- callback: ((err?) => void)
  - - (err?): void
    - Parameters
      Optional err: Error
      Returns void
Returns void
Implementation of Writable._write

`Optional` _writev

_writev(chunks, callback): void
Parameters
- chunks: {
  chunk: any;
  encoding: string;
  }[]
- callback: ((err?) => void)
  - - (err?): void
    - Parameters
      Optional err: Error
      Returns void
Returns void
Implementation of Writable._writev

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: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of Writable.addListener
Inherited from Readable.addListener
addListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.addListener
Inherited from Readable.addListener
addListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of Writable.addListener
Inherited from Readable.addListener
addListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.addListener
Inherited from Readable.addListener
addListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.addListener
Inherited from Readable.addListener
addListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Writable.addListener
Inherited from Readable.addListener

cork

cork(): void
Returns void
Implementation of Writable.cork

destroy

destroy(error?): void
Parameters
- Optional error: Error
Returns void
Implementation of Writable.destroy
Inherited from Readable.destroy

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
emit(event): boolean
Parameters
- event: "close"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
emit(event, chunk): boolean
Parameters
- event: "data"
- chunk: string | Buffer
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
emit(event): boolean
Parameters
- event: "end"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
emit(event): boolean
Parameters
- event: "readable"
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Implementation of Writable.emit
Inherited from Readable.emit

end

end(cb?): void
Parameters
- Optional cb: Function
Returns void
Implementation of Writable.end
end(chunk, cb?): void
Parameters
- chunk: any
- Optional cb: Function
Returns void
Implementation of Writable.end
end(chunk, encoding?, cb?): void
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: Function
Returns void
Implementation of Writable.end

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of Writable.eventNames
Inherited from Readable.eventNames

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of Writable.getMaxListeners
Inherited from Readable.getMaxListeners

isPaused

isPaused(): boolean
Returns boolean
Inherited from Readable.isPaused

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Implementation of Writable.listenerCount
Inherited from Readable.listenerCount

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of Writable.listeners
Inherited from Readable.listeners

on

on(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of Writable.on
Inherited from Readable.on
on(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.on
Inherited from Readable.on
on(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of Writable.on
Inherited from Readable.on
on(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.on
Inherited from Readable.on
on(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.on
Inherited from Readable.on
on(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Writable.on
Inherited from Readable.on

once

once(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of Writable.once
Inherited from Readable.once
once(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.once
Inherited from Readable.once
once(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of Writable.once
Inherited from Readable.once
once(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.once
Inherited from Readable.once
once(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.once
Inherited from Readable.once
once(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Writable.once
Inherited from Readable.once

pause

pause(): this
Returns this
Inherited from Readable.pause

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

prependListener

prependListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of Writable.prependListener
Inherited from Readable.prependListener
prependListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.prependListener
Inherited from Readable.prependListener
prependListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of Writable.prependListener
Inherited from Readable.prependListener
prependListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.prependListener
Inherited from Readable.prependListener
prependListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.prependListener
Inherited from Readable.prependListener
prependListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Writable.prependListener
Inherited from Readable.prependListener

prependOnceListener

prependOnceListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of Writable.prependOnceListener
Inherited from Readable.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.prependOnceListener
Inherited from Readable.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of Writable.prependOnceListener
Inherited from Readable.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.prependOnceListener
Inherited from Readable.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.prependOnceListener
Inherited from Readable.prependOnceListener
prependOnceListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Writable.prependOnceListener
Inherited from Readable.prependOnceListener

push

push(chunk, encoding?): boolean
Parameters
- chunk: any
- Optional encoding: string
Returns boolean
Inherited from Readable.push

read

read(size?): any
Parameters
- Optional size: number
Returns any
Inherited from Readable.read

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: string | symbol
Returns this
Implementation of Writable.removeAllListeners
Inherited from Readable.removeAllListeners

removeListener

removeListener(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Implementation of Writable.removeListener
Inherited from Readable.removeListener
removeListener(event, listener): this
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.removeListener
Inherited from Readable.removeListener
removeListener(event, listener): this
Parameters
- event: "data"
- listener: ((chunk) => void)
  - - (chunk): void
    - Parameters
      chunk: string | Buffer
      Returns void
Returns this
Implementation of Writable.removeListener
Inherited from Readable.removeListener
removeListener(event, listener): this
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.removeListener
Inherited from Readable.removeListener
removeListener(event, listener): this
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Implementation of Writable.removeListener
Inherited from Readable.removeListener
removeListener(event, listener): this
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns this
Implementation of Writable.removeListener
Inherited from Readable.removeListener

resume

resume(): this
Returns this
Inherited from Readable.resume

setDefaultEncoding

setDefaultEncoding(encoding): this
Parameters
- encoding: string
Returns this
Implementation of Writable.setDefaultEncoding

setEncoding

setEncoding(encoding): this
Parameters
- encoding: string
Returns this
Inherited from Readable.setEncoding

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Implementation of Writable.setMaxListeners
Inherited from Readable.setMaxListeners

uncork

uncork(): void
Returns void
Implementation of Writable.uncork

unpipe

unpipe<T>(destination?): this
Type Parameters
- T extends WritableStream
Parameters
- Optional destination: T
Returns this
Inherited from Readable.unpipe

unshift

unshift(chunk): void
Parameters
- chunk: any
Returns void
Inherited from Readable.unshift

wrap

wrap(oldStream): this
Parameters
- oldStream: ReadableStream
Returns this
Inherited from Readable.wrap

write

write(chunk, cb?): boolean
Parameters
- chunk: any
- Optional cb: Function
Returns boolean
Implementation of Writable.write
write(chunk, encoding?, cb?): boolean
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: Function
Returns boolean
Implementation of Writable.write

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from Readable.listenerCount

Class Duplex

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: internal.DuplexOptions

Returns Duplex

Properties

readable

Readonly readableHighWaterMark

writable

Readonly writableHighWaterMark

Static defaultMaxListeners

Methods

_destroy

Parameters

error: null | Error

callback: ((error?) => void)

Parameters

Optional error: Error

Returns void

Returns void

_final

Parameters

callback: Function

Returns void

_read

Parameters

size: number

Returns void

_write

Parameters

chunk: any

encoding: string

callback: ((err?) => void)

Parameters

Optional err: Error

Returns void

Returns void

Optional _writev

Parameters

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

callback: ((err?) => void)

Parameters

Optional err: Error

Returns void

Returns void

addListener

Parameters

event: string

listener: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: (() => void)

Returns void

Returns this

Parameters

event: "data"

listener: ((chunk) => void)

Parameters

chunk: string | Buffer

Returns void

Returns this

Parameters

event: "end"

listener: (() => void)

Returns void

Returns this

Parameters

event: "readable"

listener: (() => void)

`Optional` opts: internal.DuplexOptions

`Readonly` readableHighWaterMark

`Readonly` writableHighWaterMark

`Static` defaultMaxListeners

`Optional` error: Error

`Optional` err: Error

`Optional` _writev

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

`Optional` err: Error

`Rest` ...args: any[]

`Optional` error: Error

`Rest` ...args: any[]

`Optional` cb: Function

`Optional` cb: Function

`Optional` encoding: string

`Optional` cb: Function

`Rest` ...args: any[]