Skip to main content

Class: abstract Plugin

Plugins may call Headlamp.registerPlugin(pluginId: string, pluginObj: Plugin) to register themselves.

They will have their initialize(register) method called at plugin initialization time.

Constructors

new Plugin()

new Plugin(): Plugin

Returns

Plugin

Methods

initialize()

abstract initialize(register: Registry): boolean | void

initialize is called for each plugin with a Registry which gives the plugin methods for doing things.

Parameters

ParameterType
registerRegistry

Returns

boolean | void

The return code is not used, but used to be required.

See

Registry

Defined in

src/plugin/lib.ts:49