# Interface ReadableOptions

interface ReadableOptions {
signal?: AbortSignal;
emitClose?: boolean;
highWaterMark?: number;
objectMode?: boolean;
construct?(this: Readable, callback: ((error?: Error) => void)): void;
destroy?(this: Readable, error: Error, callback: ((error?: Error) => void)): void;
autoDestroy?: boolean;
encoding?: BufferEncoding;
read?(this: Readable, size: number): void;
}

#### Hierarchy (view full)

- StreamOptions<Readable>
  - ReadableOptions
    - DuplexOptions

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

#####
Index

### Properties

signal?
emitClose?
highWaterMark?
objectMode?
autoDestroy?
encoding?

### Methods

construct?
destroy?
read?

##
Properties

### `Optional` signal

signal?: AbortSignal

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

Inherited from StreamOptions.signal

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

### `Optional` emitClose

emitClose?: boolean

Inherited from StreamOptions.emitClose

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

### `Optional` highWaterMark

highWaterMark?: number

Inherited from StreamOptions.highWaterMark

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

### `Optional` objectMode

objectMode?: boolean

Inherited from StreamOptions.objectMode

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

### `Optional` autoDestroy

autoDestroy?: boolean

Inherited from StreamOptions.autoDestroy

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

### `Optional` encoding

encoding?: BufferEncoding

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

##
Methods

### `Optional` construct

- construct(this, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Inherited from StreamOptions.construct

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

### `Optional` destroy

- destroy(this, error, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Inherited from StreamOptions.destroy

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

### `Optional` read

- read(this, size): void

- #### Parameters

  - this: Readable
  - size: number

  #### Returns void

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