createEvent
Creates an event with the specified data and run function.
Signature
export declare function createEvent<E extends ClientNameEvents | CustomEventsKeys>(data: { data: { name: E; once?: boolean; }; run: (...args: ResolveEventParams<E>) => Awaitable<unknown>;}): { data: { name: E; once?: boolean; }; run: (...args: ResolveEventParams<E>) => Awaitable<unknown>;};JSDoc
Parameters
data- The event data.
Returns
The created event.
Examples
const myEvent = createEvent({
data: { name: 'ready', once: true },
run: (user, client, shard) => {
client.logger.info(`Start ${user.username} on shard #${shard}`);
}
});Members
This export does not declare public properties or methods in the generated declaration file.