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: use wrapper utilities (#9945)

Browse Source 
* types: use `Awaitable<T>` instead of `Promise<T> | T`

* types: use `JSONEncodable<T>` over raw definition

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Aura
2023-11-12 22:40:59 +01:00
committed by GitHub
parent cc07a28f12
commit 4bc1dae36f
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1129,7 +1129,7 @@ export abstract class Collector<Key, Value, Extras extends unknown[] = []> exten
public toJSON(): unknown; public toJSON(): unknown;
protected listener: (...args: any[]) => void; protected listener: (...args: any[]) => void;
public abstract collect(...args: unknown[]): Key | null | Promise<Key | null>; public abstract collect(...args: unknown[]): Awaitable<Key | null>;
public abstract dispose(...args: unknown[]): Key | null; public abstract dispose(...args: unknown[]): Key | null;
public on<EventKey extends keyof CollectorEventTypes<Key, Value, Extras>>( public on<EventKey extends keyof CollectorEventTypes<Key, Value, Extras>>(
@@ -5066,7 +5066,7 @@ export interface CloseEvent {
reason: string; reason: string;
} }
export type CollectorFilter<Arguments extends unknown[]> = (...args: Arguments) => boolean | Promise<boolean>; export type CollectorFilter<Arguments extends unknown[]> = (...args: Arguments) => Awaitable<boolean>;
export interface CollectorOptions<FilterArguments extends unknown[]> { export interface CollectorOptions<FilterArguments extends unknown[]> {
filter?: CollectorFilter<FilterArguments>; filter?: CollectorFilter<FilterArguments>;
@@ -6647,7 +6647,7 @@ export type Serialized<Value> = Value extends symbol | bigint | (() => any)
? never ? never
: Value extends number | string | boolean | undefined : Value extends number | string | boolean | undefined
? Value ? Value
: Value extends { toJSON(): infer JSONResult } : Value extends JSONEncodable<infer JSONResult>
? JSONResult ? JSONResult
: Value extends ReadonlyArray<infer ItemType> : Value extends ReadonlyArray<infer ItemType>
? Serialized<ItemType>[] ? Serialized<ItemType>[]

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

@@ -185,6 +185,7 @@ import {
PartialEmojiOnlyId, PartialEmojiOnlyId,
Emoji, Emoji,
PartialEmoji, PartialEmoji,
Awaitable,
} from '.'; } from '.';
import { expectAssignable, expectNotAssignable, expectNotType, expectType } from 'tsd'; import { expectAssignable, expectNotAssignable, expectNotType, expectType } from 'tsd';
import type { ContextMenuCommandBuilder, SlashCommandBuilder } from '@discordjs/builders'; import type { ContextMenuCommandBuilder, SlashCommandBuilder } from '@discordjs/builders';
@@ -412,7 +413,7 @@ client.on('messageCreate', async message => {
( (
test: ButtonInteraction<'cached'>, test: ButtonInteraction<'cached'>,
items: Collection<Snowflake, ButtonInteraction<'cached'>>, items: Collection<Snowflake, ButtonInteraction<'cached'>>,
) => boolean | Promise<boolean> ) => Awaitable<boolean>
>(buttonCollector.filter); >(buttonCollector.filter);
expectType<GuildTextBasedChannel>(message.channel); expectType<GuildTextBasedChannel>(message.channel);
expectType<Guild>(message.guild); expectType<Guild>(message.guild);

3
packages/rest/src/lib/utils/types.ts
View File

@@ -1,6 +1,7 @@
import type { Readable } from 'node:stream'; import type { Readable } from 'node:stream';
import type { ReadableStream } from 'node:stream/web'; import type { ReadableStream } from 'node:stream/web';
import type { Collection } from '@discordjs/collection'; import type { Collection } from '@discordjs/collection';
import type { Awaitable } from '@discordjs/util';
import type { Agent, Dispatcher, RequestInit, BodyInit, Response } from 'undici'; import type { Agent, Dispatcher, RequestInit, BodyInit, Response } from 'undici';
import type { IHandler } from '../interfaces/Handler.js'; import type { IHandler } from '../interfaces/Handler.js';
@@ -183,7 +184,7 @@ export interface RateLimitData {
/** /**
* A function that determines whether the rate limit hit should throw an Error * A function that determines whether the rate limit hit should throw an Error
*/ */
export type RateLimitQueueFilter = (rateLimitData: RateLimitData) => Promise<boolean> | boolean; export type RateLimitQueueFilter = (rateLimitData: RateLimitData) => Awaitable<boolean>;
export interface APIRequest { export interface APIRequest {
/** /**