Class: DevToolsPlugin

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:55

Read-only observer plugin that exposes a container subtree to an inspector backend (a Chrome extension or a standalone dev panel).

Example

import { Container, type WirestatePlugin } from "@wirestate/core";
import { DevToolsPlugin } from "@wirestate/core/devtools";

const plugins: Array<WirestatePlugin> = process.env.NODE_ENV === "production" ? [] : [new DevToolsPlugin()];

new Container({ plugins });

Implements

• WirestatePlugin

Constructors

Constructor

new DevToolsPlugin(config?: DevToolsPluginConfig): DevToolsPlugin;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:74

Parameters

Parameter	Type	Description
config?	DevToolsPluginConfig	Optional plugin configuration (see DevToolsPluginConfig).

Returns

DevToolsPlugin

Methods

install()

install(): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:78

Contributes bindings (or other one-time setup) when the plugin is registered.

Returns

void

Remarks

Runs once, on the container the plugin is registered on (not on inheriting children), before any binding activates.

Implementation of

WirestatePlugin.install

---

onActivate()

onActivate(instance: object, container: Container): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:127

Runs after a service instance is activated, before its @OnActivated.

Parameters

Parameter	Type	Description
instance	object	The activated instance.
container	Container	Container that activated it.

Returns

void

Implementation of

WirestatePlugin.onActivate

---

onContainerDeprovision()

onContainerDeprovision(container: Container): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:90

Runs once at the end of a container deprovision cycle, after all teardown.

Parameters

Parameter	Type	Description
container	Container	Container being deprovisioned.

Returns

void

Implementation of

WirestatePlugin.onContainerDeprovision

---

onContainerProvision()

onContainerProvision(container: Container): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:83

Runs once at the start of a container provision cycle, before instance wiring.

Parameters

Parameter	Type	Description
container	Container	Container being provisioned.

Returns

void

Implementation of

WirestatePlugin.onContainerProvision

---

onDeactivate()

onDeactivate(instance: object, container: Container): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:131

Runs as a service instance is deactivated, after its @OnDeactivation.

Parameters

Parameter	Type	Description
instance	object	The instance being deactivated.
container	Container	Container that owns it.

Returns

void

Implementation of

WirestatePlugin.onDeactivate

---

onDeprovision()

onDeprovision(instance: object, container: Container): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:139

Runs as a provisioned instance is deprovisioned, after its @OnDeprovision.

Parameters

Parameter	Type	Description
instance	object	The instance being deprovisioned.
container	Container	Container that owns it.

Returns

void

Implementation of

WirestatePlugin.onDeprovision

---

onProvision()

onProvision(instance: object, container: Container): void;

Defined in: src/wirestate-core/plugin/devtools/devtools-plugin.ts:135

Wires a provisioned instance, before any user @OnProvision.

Parameters

Parameter	Type	Description
instance	object	The provisioned instance.
container	Container	Container being provisioned.

Returns

void

Remarks

Register teardown with addDisposer. Disposers run (reverse order, failsafe) at deprovision. A throw here unwinds the whole provision cycle.

Implementation of

WirestatePlugin.onProvision