Interface DuplexOptions

interface DuplexOptions {
    allowHalfOpen?: boolean;
    autoDestroy?: boolean;
    decodeStrings?: boolean;
    defaultEncoding?: string;
    emitClose?: boolean;
    encoding?: string;
    highWaterMark?: number;
    objectMode?: boolean;
    readableHighWaterMark?: number;
    readableObjectMode?: boolean;
    writableCorked?: number;
    writableHighWaterMark?: number;
    writableObjectMode?: boolean;
    destroy?(this, error, callback): void;
    final?(this, callback): void;
    read?(this, size): void;
    write?(this, chunk, encoding, callback): void;
    writev?(this, chunks, callback): void;
}

Hierarchy

Properties

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

Methods

destroy? final? read? write? writev?

Properties

Optional allowHalfOpen

allowHalfOpen?: boolean

Optional autoDestroy

autoDestroy?: boolean

Optional decodeStrings

decodeStrings?: boolean

Optional defaultEncoding

defaultEncoding?: string

Optional emitClose

emitClose?: boolean

Optional encoding

encoding?: string

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional readableObjectMode

readableObjectMode?: boolean

Optional writableCorked

writableCorked?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Optional writableObjectMode

writableObjectMode?: boolean

Methods

Optional destroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          Returns void

    Returns void

Optional final

  • final(this, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional read

  • read(this, size): void

  • Parameters

    Returns void

Optional write

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional writev

  • writev(this, chunks, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page