atvik
    Preparing search index...

    Interface EventIterator<Args>

    Async iterator over the events of a Subscribable or AsyncSubscribable. Each value is the array of arguments of an event.

    The iterator subscribes on the first call to next() and unsubscribes when return() is called. A for await ... of loop calls return() when the loop exits. The iterator is also AsyncDisposable, so await using can stop it:

    await using iterator = event.iterator();
    const { value } = await iterator.next();
    interface EventIterator<Args extends unknown[]> {
        "[asyncDispose]"(): PromiseLike<void>;
        "[asyncIterator]"(): EventIterator<Args>;
        next(...__namedParameters: [] | [any]): Promise<IteratorResult<Args, any>>;
        return(value?: any): Promise<IteratorResult<Args, any>>;
        throw?(e?: any): Promise<IteratorResult<Args, any>>;
    }

    Type Parameters

    • Args extends unknown[]

    Hierarchy

    • AsyncIterableIterator<Args>
    • AsyncDisposable
      • EventIterator
    Index
    • Returns PromiseLike<void>

    • Parameters

      • ...__namedParameters: [] | [any]

      Returns Promise<IteratorResult<Args, any>>

    • Stop the iterator and unsubscribe its listener.

      Parameters

      • Optionalvalue: any

        value to return

      Returns Promise<IteratorResult<Args, any>>

      promise that resolves when the listener is unsubscribed

    • Parameters

      • Optionale: any

      Returns Promise<IteratorResult<Args, any>>