tuil
ReferencePackages@mwillbanks/tuil-pluginAPI

PluginRegistryEntry

interface exported by @mwillbanks/tuil-plugin.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-plugin.

export interface PluginRegistryEntry<
  TEvents extends EventMap = EventMap,
  TExtensions extends ExtensionPointMap = DefaultExtensionPoints,
> {
  readonly plugin: Plugin<TEvents, TExtensions>;
  readonly description?: string;
  readonly tags?: readonly string[];
}

Members

MemberTypeRequiredDescriptionRelated types
pluginPlugin<TEvents, TExtensions>YesThe plugin member uses the Plugin<TEvents, TExtensions> contract.Plugin
descriptionstring | undefinedNoThe description member uses the string | undefined contract.
tagsreadonly string[] | undefinedNoThe tags member uses the readonly string[] | undefined contract.

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

On this page