SeyfertPlugin Interface

seyfertlib/client/plugins/types.d.ts

Signature

export interface SeyfertPlugin<E extends object = {}, C extends object = {}, I extends readonly AnySeyfertPlugin[] = readonly [], M extends PluginMiddlewareMap = {}>

Properties

name instanceId version imports requires meta client ctx middlewares globalMiddlewares

Methods

options register setup teardown

Properties

name

name: string;

instanceId

instanceId?: string;

version

version?: string;

imports

imports?: I;

requires

requires?: readonly PluginRequirementInput[];

meta

meta?: unknown;

client

client?: PluginClientMap<E, I>;

ctx

ctx?: PluginContextMap<C, I, E>;

middlewares

middlewares?: M;

globalMiddlewares

globalMiddlewares?: readonly (keyof M & string)[];

Methods

options

options?(current: Readonly<BaseClientOptions>): SeyfertPluginOptions;

register

register?(api: SeyfertPluginApi<M, ExtendOf<I> & E>): void;

setup

setup?(client: SeyfertPluginClient & ExtendOf<I> & E, api?: SeyfertPluginApi<M, ExtendOf<I> & E>): Awaitable<void>;

teardown

teardown?(client: SeyfertPluginClient & ExtendOf<I> & E, api?: SeyfertPluginTeardownApi): Awaitable<void>;