Interface Plugin

A Clide-JS plugin

interface Plugin {
    description?: string;
    init: ((context) => MaybePromise<boolean>);
    meta?: {
        [key: string]: any;
    };
    name: string;
    version: string;
}

Hierarchy (view full)

Properties

description? init meta? name version

Properties

Optional description

description?: string

A description of the plugin.

init

init: ((context) => MaybePromise<boolean>)

Initialize the plugin.

Type declaration

    • (context): MaybePromise<boolean>

    • Parameters

      Returns MaybePromise<boolean>

Returns

A boolean or promise that resolves to a boolean indicating whether the plugin was successfully initialized.

Optional meta

meta?: {
    [key: string]: any;
}

Any additional metadata about the plugin. This is useful for plugins that need to provide additional data to other plugins or commands.

Type declaration

  • [key: string]: any

name

name: string

The name of the plugin.

version

version: string

The version of the plugin.

Settings

Member Visibility

Theme

On This Page

descriptioninitmetanameversion