Interface ReadableOptions

Hierarchy

<internal>.internal.StreamOptions<<internal>.Readable>
- ReadableOptions
  - DuplexOptions

Index

Properties

Methods

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: <internal>.Readable, callback: (error?: null | Error) => void): void

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

Optional destroy

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

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

Optional read

read(this: <internal>.Readable, size: number): void

- Defined in node_modules/@types/node/stream.d.ts:45
Parameters
- this: <internal>.Readable
- size: number
Returns void

Generated using TypeDoc