# PluginRegistryEntry

Source: /tuil/docs/reference/packages/plugin/api/plugin-registry-entry
Locale: en

interface exported by @mwillbanks/tuil-plugin.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-plugin`.

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

## Members [#members]

| Member        | Type                             | Required | Description                                                           | Related types                                          |
| ------------- | -------------------------------- | -------- | --------------------------------------------------------------------- | ------------------------------------------------------ |
| `plugin`      | `Plugin<TEvents, TExtensions>`   | Yes      | The `plugin` member uses the `Plugin<TEvents, TExtensions>` contract. | [`Plugin`](/tuil/docs/reference/packages/plugin/api/plugin) |
| `description` | `string \| undefined`            | No       | The `description` member uses the `string \| undefined` contract.     | —                                                      |
| `tags`        | `readonly string[] \| undefined` | No       | The `tags` member uses the `readonly string[] \| undefined` contract. | —                                                      |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`DefaultExtensionPoints`](/tuil/docs/reference/packages/plugin/api/default-extension-points)
* [`ExtensionPointMap`](/tuil/docs/reference/packages/plugin/api/extension-point-map)
* [`Plugin`](/tuil/docs/reference/packages/plugin/api/plugin)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/plugin/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-plugin](/tuil/docs/reference/packages/plugin)