Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-17 12:03:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

types(Client): EventEmitter static method overrides (#10360)

Browse Source 
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
René
2024-08-20 10:52:36 +01:00
committed by GitHub
parent 5d92525596
commit 9b707f2b83
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
packages/discord.js/typings/index.d.ts vendored
View File

@@ -244,20 +244,6 @@ import {
RawWidgetMemberData, RawWidgetMemberData,
} from './rawDataTypes.js'; } from './rawDataTypes.js';
declare module 'node:events' {
class EventEmitter {
// Add type overloads for client events.
public static once<Emitter extends EventEmitter, Event extends keyof ClientEvents>(
eventEmitter: Emitter,
eventName: Emitter extends Client ? Event : string,
): Promise<Emitter extends Client ? ClientEvents[Event] : any[]>;
public static on<Emitter extends EventEmitter, Events extends keyof ClientEvents>(
eventEmitter: Emitter,
eventName: Emitter extends Client ? Events : string,
): AsyncIterableIterator<Emitter extends Client ? ClientEvents[Events] : any>;
}
}
//#region Classes //#region Classes
export class Activity { export class Activity {
@@ -999,6 +985,18 @@ export class Client<Ready extends boolean = boolean> extends BaseClient {
// This a technique used to brand the ready state. Or else we'll get `never` errors on typeguard checks. // This a technique used to brand the ready state. Or else we'll get `never` errors on typeguard checks.
private readonly _ready: Ready; private readonly _ready: Ready;
// Override inherited static EventEmitter methods, with added type checks for Client events.
public static once<Emitter extends EventEmitter, Event extends keyof ClientEvents>(
eventEmitter: Emitter,
eventName: Emitter extends Client ? Event : string | symbol,
options?: { signal?: AbortSignal | undefined },
): Promise<Emitter extends Client ? ClientEvents[Event] : any[]>;
public static on<Emitter extends EventEmitter, Event extends keyof ClientEvents>(
eventEmitter: Emitter,
eventName: Emitter extends Client ? Event : string | symbol,
options?: { signal?: AbortSignal | undefined },
): AsyncIterableIterator<Emitter extends Client ? ClientEvents[Event] : any[]>;
public application: If<Ready, ClientApplication>; public application: If<Ready, ClientApplication>;
public channels: ChannelManager; public channels: ChannelManager;
public get emojis(): BaseGuildEmojiManager; public get emojis(): BaseGuildEmojiManager;

4
packages/discord.js/typings/index.test-d.ts
View File

@@ -1297,6 +1297,10 @@ client.on('guildCreate', async g => {
); );
}); });
// EventEmitter static method overrides
expectType<Promise<[Client<true>]>>(Client.once(client, 'ready'));
expectType<AsyncIterableIterator<[Client<true>]>>(Client.on(client, 'ready'));
client.login('absolutely-valid-token'); client.login('absolutely-valid-token');
declare const loggedInClient: Client<true>; declare const loggedInClient: Client<true>;