Interface ReadableOptions

Hierarchy

internal.StreamOptions<Readable>
- ReadableOptions

Index

Properties

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

Methods

construct? destroy? read?

Properties

`Optional` autoDestroy

autoDestroy?: boolean

`Optional` emitClose

emitClose?: boolean

`Optional` encoding

encoding?: BufferEncoding

`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: Readable, callback: ((error?: null | Error) => void)): void
Parameters
- this: Readable
- callback: ((error?: null | Error) => void)
  - - (error?: null | Error): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Inherited from StreamOptions.construct
- Defined in node_modules/@types/node/stream.d.ts:41

`Optional` destroy

destroy(this: Readable, error: null | Error, callback: ((error: null | Error) => void)): void
Parameters
- this: Readable
- error: null | Error
- callback: ((error: null | Error) => void)
  - - (error: null | Error): void
    - Parameters
      
      error: null | Error
      
      Returns void
Returns void
Inherited from StreamOptions.destroy
- Defined in node_modules/@types/node/stream.d.ts:42

`Optional` read

read(this: Readable, size: number): void
Parameters
- this: Readable
- size: number
Returns void
- Defined in node_modules/@types/node/stream.d.ts:47