Interface DuplexOptions

Hierarchy

<internal>.internal.ReadableOptions
<internal>.WritableOptions
- DuplexOptions
  - TransformOptions

Properties

Optional allowHalfOpen

allowHalfOpen?: boolean

Optional autoDestroy

autoDestroy?: boolean

Optional decodeStrings

decodeStrings?: boolean

Optional defaultEncoding

defaultEncoding?: BufferEncoding

Optional emitClose

emitClose?: boolean

Optional encoding

encoding?: BufferEncoding

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional readableObjectMode

readableObjectMode?: boolean

Optional signal

signal?: <internal>.AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

Optional writableCorked

writableCorked?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Optional writableObjectMode

writableObjectMode?: boolean

Methods

Optional construct

construct(this: Duplex, callback: (error?: null | <internal>.Error) => void): void

Overrides WritableOptions.construct
- Defined in node_modules/@types/node/stream.d.ts:778
Parameters
- this: Duplex
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional destroy

destroy(this: Duplex, error: null | <internal>.Error, callback: (error: null | <internal>.Error) => void): void

Overrides WritableOptions.destroy
- Defined in node_modules/@types/node/stream.d.ts:790
Parameters
- this: Duplex
- error: null | <internal>.Error
- callback: (error: null | <internal>.Error) => void
  - - (error: null | <internal>.Error): void
    - Parameters
      - error: null | <internal>.Error
      Returns void
Returns void

Optional final

final(this: Duplex, callback: (error?: null | <internal>.Error) => void): void

Overrides WritableOptions.final
- Defined in node_modules/@types/node/stream.d.ts:789
Parameters
- this: Duplex
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional read

read(this: Duplex, size: number): void

Overrides ReadableOptions.read
- Defined in node_modules/@types/node/stream.d.ts:779
Parameters
- this: Duplex
- size: number
Returns void

Optional write

write(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: null | <internal>.Error) => void): void

Overrides WritableOptions.write
- Defined in node_modules/@types/node/stream.d.ts:780
Parameters
- this: Duplex
- chunk: any
- encoding: BufferEncoding
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional writev

writev(this: Duplex, chunks: { chunk: any; encoding: BufferEncoding }[], callback: (error?: null | <internal>.Error) => void): void

Overrides WritableOptions.writev
- Defined in node_modules/@types/node/stream.d.ts:781
Parameters
- this: Duplex
- chunks: { chunk: any; encoding: BufferEncoding }[]
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Generated using TypeDoc