Plugin

Defined in: packages/client/src/plugins/plugin.ts:11

A registered plugin: its state, its current bricks, and load() / unload() / reload(). A failed reload keeps the previous bricks.

Properties

description

readonly description: string | undefined;

Defined in: packages/client/src/plugins/plugin.ts:13

name

readonly name: string;

Defined in: packages/client/src/plugins/plugin.ts:12

Accessors

bricks

Get Signature

get bricks(): readonly Brick<unknown>[];

Defined in: packages/client/src/plugins/plugin.ts:39

Returns

readonly Brick<unknown>[]

loaded

Get Signature

get loaded(): boolean;

Defined in: packages/client/src/plugins/plugin.ts:35

Returns

boolean

state

Get Signature

get state(): PluginState;

Defined in: packages/client/src/plugins/plugin.ts:31

Returns

PluginState

Methods

load()

load(): Promise<void>;

Defined in: packages/client/src/plugins/plugin.ts:43

Returns

Promise<void>

reload()

reload(): Promise<void>;

Defined in: packages/client/src/plugins/plugin.ts:56

Returns

Promise<void>

unload()

unload(): Promise<void>;

Defined in: packages/client/src/plugins/plugin.ts:50

Returns

Promise<void>