Interface StreamOptions<T>

Type Parameters

T extends "stream".Stream

Hierarchy

"events".EventEmitter.Abortable
- StreamOptions

Index

Properties

autoDestroy? emitClose? highWaterMark? objectMode? signal?

Methods

construct? destroy?

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?: Error) => void)): void
Parameters
- this: T
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void

`Optional` destroy

destroy(this: T, error: Error, callback: ((error: Error) => void)): void
Parameters
- this: T
- error: Error
- callback: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns void

Generated using TypeDoc