Manages tracking and receiving of all received items and hints.

Hierarchy (view full)

Accessors

Methods

Accessors

Methods

  • Removes an existing event listener.

    Type Parameters

    • Event extends
          | "itemsReceived"
          | "hintReceived"
          | "hintFound"
          | "hintsInitialized"

    Parameters

    • event: Event

      The event name associated with this listener to remove.

    • listener: ((...args: ItemEvents[Event]) => void)

      The callback function to remove.

    Returns this

    This object.

  • Add an event listener for a specific event.

    Type Parameters

    • Event extends
          | "itemsReceived"
          | "hintReceived"
          | "hintFound"
          | "hintsInitialized"

    Parameters

    • event: Event

      The event name to listen for.

    • listener: ((...args: ItemEvents[Event]) => void)

      The callback function to fire when this event is received.

    Returns this

    This object.

  • Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.

    Type Parameters

    • Event extends
          | "itemsReceived"
          | "hintReceived"
          | "hintFound"
          | "hintsInitialized"

    Parameters

    • event: Event

      The event name to listen for.

    • clearPredicate: ((...args: ItemEvents[Event]) => boolean) = ...

      An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.

    Returns Promise<ItemEvents[Event]>