Interface DuplexOptions

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

Hierarchy (View Summary)

Properties

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

Methods

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

Properties

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalautoDestroy

autoDestroy?: boolean

OptionaldecodeStrings

decodeStrings?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

OptionalemitClose

emitClose?: boolean

Optionalencoding

encoding?: BufferEncoding

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

OptionalreadableHighWaterMark

readableHighWaterMark?: number

OptionalreadableObjectMode

readableObjectMode?: boolean

Optionalsignal

signal?: AbortSignal

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

OptionalwritableCorked

writableCorked?: number

OptionalwritableHighWaterMark

writableHighWaterMark?: number

OptionalwritableObjectMode

writableObjectMode?: boolean

Methods

Optionalconstruct

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

  • Parameters

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

    Returns void

Optionaldestroy

  • destroy(
        this: Duplex,
        error: null | Error,
        callback: (error?: null | Error) => void,
    ): void

  • Parameters

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

    Returns void

Optionalfinal

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

  • Parameters

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

    Returns void

Optionalread

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

  • Parameters

    Returns void

Optionalwrite

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

  • Parameters

    Returns void

Optionalwritev

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

  • Parameters

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

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods