Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageStreamOptions

Hierarchy

  • DuplexOptions
    • MessageStreamOptions

Index

Properties

Methods

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 maxBsonMessageSize

maxBsonMessageSize?: number

Optional objectMode

objectMode?: boolean

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional readableObjectMode

readableObjectMode?: boolean

Optional signal

signal?: 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(callback: (error?: null | Error) => void): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional destroy

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

  • Parameters

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

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Optional final

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional read

  • read(size: number): void

  • Parameters

    • size: number

    Returns void

Optional write

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional writev

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Generated using TypeDoc