Skip to content

Function: definePlugin()

Call Signature

definePlugin<Id, Doc, Options>(input): ConfigurablePlugin<Id, Doc, Options>

Defined in: plugin-sdk/src/index.ts:88

Validates the static shape of a plugin and returns it typed for the registry.

Type Parameters

Id

Id extends string

Doc

Doc

Options

Options extends object

Parameters

input

PluginInput<Id, Doc, Options> & object

Returns

ConfigurablePlugin<Id, Doc, Options>

Call Signature

definePlugin<Id, Doc>(input): SealpixelPlugin<Id, Doc>

Defined in: plugin-sdk/src/index.ts:91

Validates the static shape of a plugin and returns it typed for the registry.

Type Parameters

Id

Id extends string

Doc

Doc

Parameters

input

PluginInput<Id, Doc, undefined>

Returns

SealpixelPlugin<Id, Doc>