For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Interface OnOptions
interface OnOptions {
close?: readonly string[];
highWaterMark?: number;
lowWaterMark?: number;
signal?: AbortSignal;
}
close?: readonly string[];
highWaterMark?: number;
lowWaterMark?: number;
signal?: AbortSignal;
}
Hierarchy (View Summary)
- Abortable
- OnOptions
Properties
Optionalclose
close?: readonly string[]
OptionalhighWaterMark
highWaterMark?: number
The high watermark. The emitter is paused every time the size of events
being buffered is higher than it. Supported only on emitters implementing
pause() and resume() methods.
OptionallowWaterMark
lowWaterMark?: number
The low watermark. The emitter is resumed every time the size of events
being buffered is lower than it. Supported only on emitters implementing
pause() and resume() methods.
Optionalsignal
signal?: AbortSignal
Names of events that will end the iteration.