Skip to main content
Version: Next

CommandKitEventDispatch

CommandKitEventDispatch​

commandkittypes.ts

Represents an event dispatched to the plugins.

Signature
interface CommandKitEventDispatch {
    name: string;
    args: unknown[];
    namespace: string | null;
    once: boolean;
    metadata: ParsedEvent;
    accept(): void;
}

name​

property
string

The name of the event.

args​

property
unknown[]

The arguments passed to the event.

namespace​

property
string | null

The namespace of the event, if any.

once​

property
boolean

If this event runs only once, it will be set to true.

metadata​

property
ParsedEvent

The additional metadata associated with the event.

accept​

method
() => void

Captures the owner of the event, preventing other plugins from handling it.