Interface DuplexOptions

interface DuplexOptions {
    signal?: AbortSignal;
    emitClose?: boolean;
    highWaterMark?: number;
    objectMode?: boolean;
    autoDestroy?: boolean;
    encoding?: BufferEncoding;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    allowHalfOpen?: boolean;
    readableObjectMode?: boolean;
    writableObjectMode?: boolean;
    readableHighWaterMark?: number;
    writableHighWaterMark?: number;
    writableCorked?: number;
    construct?(this: Duplex, callback: ((error?: Error) => void)): void;
    read?(this: Duplex, size: number): void;
    write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: ((error?: Error) => void)): void;
    writev?(this: Duplex, chunks: {
        chunk: any;
        encoding: BufferEncoding;
    }[], callback: ((error?: Error) => void)): void;
    final?(this: Duplex, callback: ((error?: Error) => void)): void;
    destroy?(this: Duplex, error: Error, callback: ((error?: Error) => void)): void;
}

Hierarchy (view full)

Properties

signal? emitClose? highWaterMark? objectMode? autoDestroy? encoding? decodeStrings? defaultEncoding? allowHalfOpen? readableObjectMode? writableObjectMode? readableHighWaterMark? writableHighWaterMark? writableCorked?

Methods

construct? read? write? writev? final? destroy?

Properties

Optionalsignal

signal?: AbortSignal

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

OptionalemitClose

emitClose?: boolean

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

OptionalautoDestroy

autoDestroy?: boolean

Optionalencoding

encoding?: BufferEncoding

OptionaldecodeStrings

decodeStrings?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalreadableObjectMode

readableObjectMode?: boolean

OptionalwritableObjectMode

writableObjectMode?: boolean

OptionalreadableHighWaterMark

readableHighWaterMark?: number

OptionalwritableHighWaterMark

writableHighWaterMark?: number

OptionalwritableCorked

writableCorked?: number

Methods

Optionalconstruct

  • construct(this, callback): void

  • Parameters

    • this: Duplex
    • callback: ((error?: Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Optionalread

  • read(this, size): void

  • Parameters

    Returns void

Optionalwrite

  • write(this, chunk, encoding, callback): void

  • Parameters

    • this: Duplex
    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?: Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Optionalwritev

  • writev(this, chunks, callback): void

  • Parameters

    • this: Duplex
    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?: Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Optionalfinal

  • final(this, callback): void

  • Parameters

    • this: Duplex
    • callback: ((error?: Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Optionaldestroy

  • destroy(this, error, callback): void

  • Parameters

    • this: Duplex
    • error: Error
    • callback: ((error?: Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods