Interface ReadableOptions

Hierarchy

"stream".StreamOptions<"stream".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: "stream".Readable<any>, callback: ((error?: Error) => void)): void
Parameters
- this: "stream".Readable<any>
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void

Inherited from StreamOptions.construct

`Optional` destroy

destroy(this: "stream".Readable<any>, error: Error, callback: ((error: Error) => void)): void
Parameters
- this: "stream".Readable<any>
- error: Error
- callback: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns void

Inherited from StreamOptions.destroy

`Optional` read

read(this: "stream".Readable<any>, size: number): void
Parameters
- this: "stream".Readable<any>
- size: number
Returns void

Generated using TypeDoc