Interface PluginMetadata

Metadata describing a plugin.

Example

{
  name: 'postgres',
  description: 'PostgreSQL database plugin',
  dependencies: ['logger'],
  optionalDependencies: ['opentelemetry']
}
interface PluginMetadata {
    name: string;
    version: string;
    description?: string;
    dependencies?: string[];
    optionalDependencies?: string[];
}

Properties

name version description? dependencies? optionalDependencies?

Properties

name

name: string

Unique name of the plugin.

version

version: string

Optionaldescription

description?: string

Description of what the plugin does.

Optionaldependencies

dependencies?: string[]

Names of plugins that this plugin depends on. These plugins will be initialized before this one.

OptionaloptionalDependencies

optionalDependencies?: string[]

Names of plugins that this plugin can optionally use. These plugins will be initialized before this one if they are present, but the plugin will still work if they are not.

Settings

Member Visibility

On This Page

Properties