Interface Options

interface Options {
objectMode?: boolean;
onEnd?(err?: Error): void;
}

Hierarchy (View Summary)

Options
- ObjectPushableOptions
- BytePushableOptions

Index

Properties

Methods

Properties

`Optional`objectMode

objectMode?: boolean

A boolean value that means non-Uint8Arrays will be passed to .push, default: false

Methods

`Optional`onEnd

onEnd?(err?: Error): void
A function called after all values have been yielded from the iterator (including buffered values). In the case when the iterator is ended with an error it will be passed the error as a parameter.
Parameters
- Optionalerr: Error
Returns void
- Defined in src/index.ts:122