PluginContext

interface

Public interface exported by @mwillbanks/tuil-plugin.

export interface PluginContext<
  TEvents extends EventMap = EventMap,
  TExtensions extends ExtensionPointMap = DefaultExtensionPoints,
> {
  readonly services: ServiceContainer;
  readonly commands: CommandRegistry;
  readonly events: EventBus<TEvents>;
  readonly routes: ExtensionRegistry<TExtensions["routes"]>;
  readonly registry: ExtensionRegistry<TExtensions["registry"]>;
  readonly workflows: ExtensionRegistry<TExtensions["workflows"]>;
  readonly theme: ExtensionRegistry<TExtensions["theme"]>;
  readonly statusBar: ExtensionRegistry<TExtensions["statusBar"]>;
  readonly appBar: ExtensionRegistry<TExtensions["appBar"]>;
  readonly menus: ExtensionRegistry<TExtensions["menus"]>;
  readonly keybindings: ExtensionRegistry<TExtensions["keybindings"]>;
  readonly dataAdapters: ExtensionRegistry<TExtensions["dataAdapters"]>;
  readonly persistenceAdapters: ExtensionRegistry<
    TExtensions["persistenceAdapters"]
  >;
  readonly operationExecutors: ExtensionRegistry<
    TExtensions["operationExecutors"]
  >;
  readonly devtools: ExtensionRegistry<TExtensions["devtools"]>;
  readonly components: ExtensionRegistry<TExtensions["components"]>;
  readonly editorProviders: ExtensionRegistry<TExtensions["editorProviders"]>;
  readonly editorCommands: ExtensionRegistry<TExtensions["editorCommands"]>;
  readonly logParsers: ExtensionRegistry<TExtensions["logParsers"]>;
  readonly themes: ExtensionRegistry<TExtensions["themes"]>;
  readonly formatAdapters: ExtensionRegistry<TExtensions["formatAdapters"]>;
  readonly renderProjections: ExtensionRegistry<
    TExtensions["renderProjections"]
  >;
  readonly devtoolsPanels: ExtensionRegistry<TExtensions["devtoolsPanels"]>;
  readonly renderers: ExtensionRegistry<TExtensions["renderers"]>;
  readonly capabilities: ReadonlySet<PluginCapability>;
  readonly signal: AbortSignal;
}

Members

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-plugin

Member	Type	Required	Description	Related types
`services`	`ServiceContainer`	Yes	The `services` member uses the `ServiceContainer` contract.	`ServiceContainer`
`commands`	`CommandRegistry`	Yes	The `commands` member uses the `CommandRegistry` contract.	`CommandRegistry`
`events`	`EventBus<TEvents>`	Yes	The `events` member uses the `EventBus<TEvents>` contract.	`EventBus`
`routes`	`ExtensionRegistry<TExtensions["routes"]>`	Yes	The `routes` member uses the `ExtensionRegistry<TExtensions["routes"]>` contract.	`ExtensionRegistry`
`registry`	`ExtensionRegistry<TExtensions["registry"]>`	Yes	The `registry` member uses the `ExtensionRegistry<TExtensions["registry"]>` contract.	`ExtensionRegistry`
`workflows`	`ExtensionRegistry<TExtensions["workflows"]>`	Yes	The `workflows` member uses the `ExtensionRegistry<TExtensions["workflows"]>` contract.	`ExtensionRegistry`
`theme`	`ExtensionRegistry<TExtensions["theme"]>`	Yes	The `theme` member uses the `ExtensionRegistry<TExtensions["theme"]>` contract.	`ExtensionRegistry`
`statusBar`	`ExtensionRegistry<TExtensions["statusBar"]>`	Yes	The `statusBar` member uses the `ExtensionRegistry<TExtensions["statusBar"]>` contract.	`ExtensionRegistry`
`appBar`	`ExtensionRegistry<TExtensions["appBar"]>`	Yes	The `appBar` member uses the `ExtensionRegistry<TExtensions["appBar"]>` contract.	`ExtensionRegistry`
`menus`	`ExtensionRegistry<TExtensions["menus"]>`	Yes	The `menus` member uses the `ExtensionRegistry<TExtensions["menus"]>` contract.	`ExtensionRegistry`
`keybindings`	`ExtensionRegistry<TExtensions["keybindings"]>`	Yes	The `keybindings` member uses the `ExtensionRegistry<TExtensions["keybindings"]>` contract.	`ExtensionRegistry`
`dataAdapters`	`ExtensionRegistry<TExtensions["dataAdapters"]>`	Yes	The `dataAdapters` member uses the `ExtensionRegistry<TExtensions["dataAdapters"]>` contract.	`ExtensionRegistry`
`persistenceAdapters`	`ExtensionRegistry<TExtensions["persistenceAdapters"]>`	Yes	The `persistenceAdapters` member uses the `ExtensionRegistry<TExtensions["persistenceAdapters"]>` contract.	`ExtensionRegistry`
`operationExecutors`	`ExtensionRegistry<TExtensions["operationExecutors"]>`	Yes	The `operationExecutors` member uses the `ExtensionRegistry<TExtensions["operationExecutors"]>` contract.	`ExtensionRegistry`
`devtools`	`ExtensionRegistry<TExtensions["devtools"]>`	Yes	The `devtools` member uses the `ExtensionRegistry<TExtensions["devtools"]>` contract.	`ExtensionRegistry`
`components`	`ExtensionRegistry<TExtensions["components"]>`	Yes	The `components` member uses the `ExtensionRegistry<TExtensions["components"]>` contract.	`ExtensionRegistry`
`editorProviders`	`ExtensionRegistry<TExtensions["editorProviders"]>`	Yes	The `editorProviders` member uses the `ExtensionRegistry<TExtensions["editorProviders"]>` contract.	`ExtensionRegistry`
`editorCommands`	`ExtensionRegistry<TExtensions["editorCommands"]>`	Yes	The `editorCommands` member uses the `ExtensionRegistry<TExtensions["editorCommands"]>` contract.	`ExtensionRegistry`
`logParsers`	`ExtensionRegistry<TExtensions["logParsers"]>`	Yes	The `logParsers` member uses the `ExtensionRegistry<TExtensions["logParsers"]>` contract.	`ExtensionRegistry`
`themes`	`ExtensionRegistry<TExtensions["themes"]>`	Yes	The `themes` member uses the `ExtensionRegistry<TExtensions["themes"]>` contract.	`ExtensionRegistry`
`formatAdapters`	`ExtensionRegistry<TExtensions["formatAdapters"]>`	Yes	The `formatAdapters` member uses the `ExtensionRegistry<TExtensions["formatAdapters"]>` contract.	`ExtensionRegistry`
`renderProjections`	`ExtensionRegistry<TExtensions["renderProjections"]>`	Yes	The `renderProjections` member uses the `ExtensionRegistry<TExtensions["renderProjections"]>` contract.	`ExtensionRegistry`
`devtoolsPanels`	`ExtensionRegistry<TExtensions["devtoolsPanels"]>`	Yes	The `devtoolsPanels` member uses the `ExtensionRegistry<TExtensions["devtoolsPanels"]>` contract.	`ExtensionRegistry`
`renderers`	`ExtensionRegistry<TExtensions["renderers"]>`	Yes	The `renderers` member uses the `ExtensionRegistry<TExtensions["renderers"]>` contract.	`ExtensionRegistry`
`capabilities`	`ReadonlySet<PluginCapability>`	Yes	The `capabilities` member uses the `ReadonlySet<PluginCapability>` contract.	`PluginCapability`
`signal`	`AbortSignal`	Yes	The `signal` member uses the `AbortSignal` contract.	—

PluginContext

On this page