Interface DuplexOptions

Hierarchy

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

Index

Properties

Methods

Properties

Optional highWaterMark

highWaterMark?: number

Optional encoding

encoding?: string

Optional objectMode

objectMode?: boolean

Optional autoDestroy

autoDestroy?: boolean

Optional decodeStrings

decodeStrings?: boolean

Optional defaultEncoding

defaultEncoding?: string

Optional emitClose

emitClose?: boolean

Optional allowHalfOpen

allowHalfOpen?: boolean

Optional readableObjectMode

readableObjectMode?: boolean

Optional writableObjectMode

writableObjectMode?: boolean

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Methods

Optional read

read(this: <internal>.Duplex, size: number): void

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

Optional write

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

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

Optional writev

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

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

Optional final

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

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

Optional destroy

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

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

Generated using TypeDoc