Skip to content

PluginSettingsComponentBase.once method

PluginSettingsComponentBase › once

Trigger an event, executing all the listeners in order even if some of them throw an error.

Add an event listener that will be called only once.

Signature:

once(name: EventName, callback: (...args: Args) => Promisable<void>, thisArg?: unknown): AsyncEventRef

Parameters:

ParameterTypeDescription
nameEventNameThe name of the event.
callback(...args: Args) => Promisable<void>The callback to call when the event is triggered.
thisArg?unknownThe context passed as this to the callback.

Returns: AsyncEventRefA reference to the event listener.

Remarks:

Not refactored to parameter-object pattern, to keep the parity with obsidian#Events#on (or once, correspondingly).