Class PluginLoader

Loads Plugins from a statically defined list of plugins that is built using the @Plugin annotation.

Hierarchy

PluginLoader

Index

Constructors

constructor

Properties

Methods

sendPluginEvent

Constructors

constructor

new PluginLoader(): PluginLoader

- Defined in plugins/Plugin.ts:40
Loads all the plugins defined in the plugins array.

Returns PluginLoader

Properties

Private pl_list

pl_list: IPlugin[] = ...

An private list of the currently instantiated plugins.

internal

Static plugins

plugins: IPlugin[] = ...

A List of plugins that will be instantiated when plugins are loaded.

Methods

sendPluginEvent

sendPluginEvent(event: "preNotebookInit" | "postNotebookInit" | "onSelectCell", ...args: any[]): void

- Defined in plugins/Plugin.ts:60
Sends a plugin event to all initialized plugins, calling the method defined in the event parameter if it exists.

remarks

If the ...args array contains too many or too few arguments, or arguments of the wrong type, it will NOT generate a compiler error, only a runtime error. This function makes use of a black-magic plugin[event](..args) call which has been made valid using @ts-expect-error. Be wary of using it outside internal contexts.

internal

Parameters
- event: "preNotebookInit" | "postNotebookInit" | "onSelectCell"
  
  The name of the event to send
- Rest ...args: any[]
  
  Optional arguments that the event method accepts
Returns void

Generated using TypeDoc