Skip to content

AsyncEventTrigger<EventMap>

Interface exposing event-triggering methods for subclasses of mixin-created classes.

These methods are protected at runtime but surfaced in the declaration type because TypeScript cannot represent protected in anonymous-class return types.

Import:

import type { AsyncEventTrigger } from '@mnaoumov/typescript-lib/async-events';

Signature:

export interface AsyncEventTrigger<EventMap extends EventMapConstraint<EventMap> = EventMapBase>

Properties

PropertyTypeDescription
trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>) => voidTrigger an event, executing all the listeners in order even if some of them throw an error.
triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>) => Promise<void>Trigger an event asynchronously.
tryTrigger<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments) => voidTry to trigger an event, executing all the listeners in order even if some of them throw an error.
tryTriggerAsync<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments) => Promise<void>Try to trigger an event asynchronously.

Links to this page: