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 'obsidian-dev-utils/async-events';

Signature:

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

Methods

MethodReturnsDescription
trigger(name, args?)voidTrigger an event, executing all the listeners in order even if some of them throw an error.
triggerAsync(name, args?)Promise<void>Trigger an event asynchronously.
tryTrigger(eventRef, args)voidTry to trigger an event, executing all the listeners in order even if some of them throw an error.
tryTriggerAsync(eventRef, args)Promise<void>Try to trigger an event asynchronously.

Links to this page: