Interface ReadableOptions

Hierarchy

"node:stream".StreamOptions<"node:stream".Readable>
- ReadableOptions
  - "node:stream".DuplexOptions

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

`Optional` destroy

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

`Optional` read

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

Generated using TypeDoc