CustomEventHandler Class

seyfertlib/events/handler.d.ts

Signature

export declare class CustomEventHandler extends BaseHandler implements CustomEventRunner

Private types

ClientWithPluginRegistryTypeAlias

type ClientWithPluginRegistry = BaseClient;

PluginEventListenerTypeAlias

type PluginEventListener = PluginOrderedContribution & {    record: {        plugin: {            name: string;            instanceId?: string;        };        index: number;    };    name: string;    handler: (...args: unknown[]) => unknown;    active: boolean;    once?: boolean;    fired?: boolean;};

PluginAnyEventListenerTypeAlias

type PluginAnyEventListener = PluginOrderedContribution & {    record: {        plugin: {            name: string;            instanceId?: string;        };        index: number;    };    handler: (name: string, ...args: unknown[]) => unknown;    active: boolean;};

Properties

client onFail values

Methods

constructor emit runCustom getPluginListeners getPluginAnyListeners getPluginErrorListeners runCollectors createPluginListenerTask settleEventTasks reportEventFailure

Properties

client

protected client: ClientWithPluginRegistry;

onFail

onFail: (event: GatewayEvents | CustomEventsKeys | string, err: unknown) => void;

values

values: Partial<EventValues>;

Methods

constructorConstructor

constructor(client: ClientWithPluginRegistry);

emit

emit<T extends CustomEventsKeys>(name: T, ...args: ResolveEventRunParams<T>): Promise<void>;

runCustom

runCustom<T extends CustomEventsKeys>(name: T, ...args: ResolveEventRunParams<T>): Promise<void>;

getPluginListeners

protected getPluginListeners(name: string): PluginEventContribution[];

getPluginAnyListeners

protected getPluginAnyListeners(): PluginAnyEventContribution[];

getPluginErrorListeners

protected getPluginErrorListeners(): PluginEventErrorContribution[];

runCollectors

protected runCollectors(name: string, args: unknown): unknown;

createPluginListenerTask

protected createPluginListenerTask(name: string, listeners: readonly PluginEventListener[], anyListeners: readonly PluginAnyEventListener[], args: readonly unknown[]): Promise<void> | undefined;

settleEventTasks

protected settleEventTasks(name: GatewayEvents | CustomEventsKeys | string, tasks: readonly Promise<unknown>[]): Promise<void>;

reportEventFailure

protected reportEventFailure(name: GatewayEvents | CustomEventsKeys | string, error: unknown): Promise<void>;