# Interface StreamOptions<T>

interface StreamOptions<T> {
signal?: AbortSignal;
emitClose?: boolean;
highWaterMark?: number;
objectMode?: boolean;
construct?(this: T, callback: ((error?: Error) => void)): void;
destroy?(this: T, error: Error, callback: ((error?: Error) => void)): void;
autoDestroy?: boolean;
}

#### Type Parameters

- T extends Stream

#### Hierarchy (view full)

- Abortable
  - StreamOptions
    - ReadableOptions
    - WritableOptions

- Defined in node_modules/@types/node/stream.d.ts:44

#####
Index

### Properties

signal?
emitClose?
highWaterMark?
objectMode?
autoDestroy?

### Methods

construct?
destroy?

##
Properties

### `Optional` signal

signal?: AbortSignal

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

Inherited from Abortable.signal

- Defined in node_modules/@types/node/events.d.ts:437

### `Optional` emitClose

emitClose?: boolean

- Defined in node_modules/@types/node/stream.d.ts:45

### `Optional` highWaterMark

highWaterMark?: number

- Defined in node_modules/@types/node/stream.d.ts:46

### `Optional` objectMode

objectMode?: boolean

- Defined in node_modules/@types/node/stream.d.ts:47

### `Optional` autoDestroy

autoDestroy?: boolean

- Defined in node_modules/@types/node/stream.d.ts:50

##
Methods

### `Optional` construct

- construct(this, callback): void

- #### Parameters

  - this: T
  - callback: ((error?: Error) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  - Defined in node_modules/@types/node/stream.d.ts:48

### `Optional` destroy

- destroy(this, error, callback): void

- #### Parameters

  - this: T
  - error: Error
  - callback: ((error?: Error) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  - Defined in node_modules/@types/node/stream.d.ts:49