Interface StreamOptions<T>

Type parameters

T: <internal>.Stream

Hierarchy-Diagram

UML class diagram of StreamOptions

Legend

icon for an interface in the UML class diagram

interface

icon for a public property in the UML class diagram

public property

icon for a public method in the UML class diagram

public method

Hierarchy

<internal>.Abortable
- StreamOptions

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 | <internal>.Error) => void): void

- Defined in node_modules/@types/node/stream.d.ts:39
Parameters
- this: T
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional destroy

destroy(this: T, error: null | <internal>.Error, callback: (error: null | <internal>.Error) => void): void

- Defined in node_modules/@types/node/stream.d.ts:40
Parameters
- this: T
- error: null | <internal>.Error
- callback: (error: null | <internal>.Error) => void
  - - (error: null | <internal>.Error): void
    - Parameters
      - error: null | <internal>.Error
      Returns void
Returns void

Generated using TypeDoc