Skip to content

PluginEventSourceImpl

Plugin event source implementation.

Import:

import { PluginEventSourceImpl } from 'obsidian-dev-utils/obsidian/plugin/plugin-event-source';

Signature:

export class PluginEventSourceImpl implements PluginEventSource

Implements: PluginEventSource

Constructor

new PluginEventSourceImpl(plugin: PluginBase)

Creates a new plugin event source.

Methods

MethodReturnsDescription
off(name, callback)voidRemove an event listener.
offref(eventRef)voidRemove an event listener by reference.
on(name, callback, thisArg?)AsyncEventRefAdd an event listener.
once(name, callback, thisArg?)AsyncEventRefAdd an event listener that will be triggered only once.