atvik
    Preparing search index...

    Interface EventIteratorOptions

    Options available for iterators of events.

    interface EventIteratorOptions {
        limit?: number;
        overflowBehavior?: OverflowBehavior;
        signal?: AbortSignal;
    }
    Index
    limit?: number

    The maximum number of events to keep queued. This is used for when processing of events is slow, and will let the iterator drop old or new events or when used with AsyncEvent block emits.

    Defaults to unlimited.

    overflowBehavior?: OverflowBehavior

    Behavior to use when this iterator has reached its limit for queued events.

    signal?: AbortSignal

    Signal that stops the iterator. When the signal is aborted the iterator unsubscribes and the iteration ends with done: true, so a for await ... of loop exits without an error.