Events

Official

Event emitter implementation

Import:

import { Events } from 'obsidian';

Signature:

export class Events

Constructor

new Events()

Constructor.

To extract the constructor type, use ExtractConstructor<Events>.

	Property	Type	Description
	_	Record<string, EventsEntry[]>	Internal storage of registered event handlers by event name.

Method	Returns	Description
off(name, callback)	void	Remove an event listener.
offref(ref)	void	Remove an event listener by reference.
on(name, callback, ctx?)	EventRef	Add an event listener.
trigger(name, data?)	void	Trigger an event, executing all the listeners in order even if some of them throw an error.
tryTrigger(evt, args)	void	Try to trigger an event, executing all the listeners in order even if some of them throw an error.

Links to this page: