Interface ReadableOptions

Hierarchy

ReadableOptions

Index

Properties

Methods

Properties

Optional highWaterMark

highWaterMark?: number

Optional encoding

encoding?: string

Optional objectMode

objectMode?: boolean

Optional autoDestroy

autoDestroy?: boolean

Methods

Optional read

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

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

Optional destroy

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

- Defined in node_modules/@types/node/stream.d.ts:16
Parameters
- this: <internal>.Readable
- error: Error
- callback: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns void

Generated using TypeDoc