Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamOptions<T>

Type Parameters

Hierarchy

Index

Properties

Methods

Properties

Optional autoDestroy

autoDestroy?: boolean

Optional emitClose

emitClose?: boolean

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional signal

signal?: AbortSignal

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

Methods

Optional construct

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional destroy

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

  • Parameters

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

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Generated using TypeDoc