AsyncEvents<EventMap>

A class that extends AsyncEventsBase and provides public methods for triggering events.

This class exists as parity with Obsidian’s Events. But exposing publicly trigger() methods violates encapsulation.

Avoid using it in favor of AsyncEventsBase.

Import:

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

Signature:

export class AsyncEvents<EventMap extends EventMapConstraint<EventMap> = EventMapBase> extends AsyncEventsBase<EventMap>

Extends: AsyncEventsBase<EventMap>

Properties

Property	Type	Description
[ASYNC_EVENT_MAP]?	EventMap	Phantom marker that makes EventMap inferable from an AsyncEventSource (e.g. via Source extends AsyncEventSource<infer EventMap>). Never present at runtime. (Inherited from AsyncEventsBase)
eventReferencesMap	Map<string, AsyncEventRef[]>	The registry mapping each event name to its list of registered listener references. (Inherited from AsyncEventsBase)
off	<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>( name: EventName, callback: (...$arguments: Arguments) => Promisable<void> ) => void	Remove an event listener. (Inherited from AsyncEventsBase)
offref	(eventRef: AsyncEventRef) => void	Remove an event listener by reference. (Inherited from AsyncEventsBase)
on	<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>( name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown ) => AsyncEventRef	Add an event listener. (Inherited from AsyncEventsBase)
once	<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>( name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown ) => AsyncEventRef	Add an event listener that will be triggered only once. (Inherited from AsyncEventsBase)

Methods

Method	Returns	Description
off(name, callback)	void	Remove an event listener. (Inherited from AsyncEventsBase)
offref(eventRef)	void	Remove an event listener by reference. (Inherited from AsyncEventsBase)
on(name, callback, thisArgument?)	AsyncEventRef	Add an event listener. (Inherited from AsyncEventsBase)
once(name, callback, thisArgument?)	AsyncEventRef	Add an event listener that will be triggered only once. (Inherited from AsyncEventsBase)
trigger(name, $arguments?)	void	Trigger an event, executing all the listeners in order even if some of them throw an error.
triggerAsync(name, $arguments?)	Promise<void>	Trigger an event asynchronously, executing all the listeners in order even if some of them throw an error.
tryTrigger(eventRef, $arguments)	void	Try to trigger an event, executing all the listeners in order even if some of them throw an error.
tryTriggerAsync(eventRef, $arguments)	Promise<void>	Try to trigger an event asynchronously, executing all the listeners in order even if some of them throw an error.