Plugin

Contract every SDK plugin must satisfy.

A plugin declares an identifier, an optional version string, and an install hook the SDK invokes once per registration. Installation may be synchronous or asynchronous; the PluginManager awaits the result either way.

Example

const MyPlugin: Plugin = {
  name: 'my-plugin',
  version: '1.0.0',
  install(sdk) {
    // attach behavior to sdk
  },
};
await sdk.plugins.use(MyPlugin);

Properties

name

name: string

Defined in: plugins/types.ts:30

Unique plugin identifier. Reinstallation is a no-op.

version?

optional version?: string

Defined in: plugins/types.ts:32

Optional semver string, surfaced for diagnostics.

Methods

install()

install(sdk): void | Promise<void>

Defined in: plugins/types.ts:34

One-shot install hook called by PluginManager.use.

Parameters

sdk

any

Returns

void | Promise<void>