From f88f4cca641935cfe64caf870ef11034b70bc947 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonio=20Rom=C3=A1n?= Date: Mon, 4 Oct 2021 14:11:42 +0200 Subject: [PATCH] types: rename `Awaited` to `Awaitable` (#6756) --- typings/index.d.ts | 90 +++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 45 deletions(-) diff --git a/typings/index.d.ts b/typings/index.d.ts index 827493276..6f6f5a1af 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -473,25 +473,25 @@ export class Client extends BaseClient { public sweepMessages(lifetime?: number): number; public toJSON(): unknown; - public on(event: K, listener: (...args: ClientEvents[K]) => Awaited): this; + public on(event: K, listener: (...args: ClientEvents[K]) => Awaitable): this; public on( event: Exclude, - listener: (...args: any[]) => Awaited, + listener: (...args: any[]) => Awaitable, ): this; - public once(event: K, listener: (...args: ClientEvents[K]) => Awaited): this; + public once(event: K, listener: (...args: ClientEvents[K]) => Awaitable): this; public once( event: Exclude, - listener: (...args: any[]) => Awaited, + listener: (...args: any[]) => Awaitable, ): this; public emit(event: K, ...args: ClientEvents[K]): boolean; public emit(event: Exclude, ...args: unknown[]): boolean; - public off(event: K, listener: (...args: ClientEvents[K]) => Awaited): this; + public off(event: K, listener: (...args: ClientEvents[K]) => Awaitable): this; public off( event: Exclude, - listener: (...args: any[]) => Awaited, + listener: (...args: any[]) => Awaitable, ): this; public removeAllListeners(event?: K): this; @@ -572,11 +572,11 @@ export abstract class Collector extends EventEmi public abstract collect(...args: unknown[]): K | null | Promise; public abstract dispose(...args: unknown[]): K | null; - public on(event: 'collect' | 'dispose', listener: (...args: [V, ...F]) => Awaited): this; - public on(event: 'end', listener: (collected: Collection, reason: string) => Awaited): this; + public on(event: 'collect' | 'dispose', listener: (...args: [V, ...F]) => Awaitable): this; + public on(event: 'end', listener: (collected: Collection, reason: string) => Awaitable): this; - public once(event: 'collect' | 'dispose', listener: (...args: [V, ...F]) => Awaited): this; - public once(event: 'end', listener: (collected: Collection, reason: string) => Awaited): this; + public once(event: 'collect' | 'dispose', listener: (...args: [V, ...F]) => Awaitable): this; + public once(event: 'end', listener: (collected: Collection, reason: string) => Awaitable): this; } export class CommandInteraction extends BaseCommandInteraction { @@ -1089,13 +1089,13 @@ export class InteractionCollector extends Collector Awaited): this; - public on(event: 'end', listener: (collected: Collection, reason: string) => Awaited): this; - public on(event: string, listener: (...args: any[]) => Awaited): this; + public on(event: 'collect' | 'dispose', listener: (interaction: T) => Awaitable): this; + public on(event: 'end', listener: (collected: Collection, reason: string) => Awaitable): this; + public on(event: string, listener: (...args: any[]) => Awaitable): this; - public once(event: 'collect' | 'dispose', listener: (interaction: T) => Awaited): this; - public once(event: 'end', listener: (collected: Collection, reason: string) => Awaited): this; - public once(event: string, listener: (...args: any[]) => Awaited): this; + public once(event: 'collect' | 'dispose', listener: (interaction: T) => Awaitable): this; + public once(event: 'end', listener: (collected: Collection, reason: string) => Awaitable): this; + public once(event: string, listener: (...args: any[]) => Awaitable): this; } export class InteractionWebhook extends PartialWebhookMixin() { @@ -1699,17 +1699,17 @@ export class Shard extends EventEmitter { public send(message: unknown): Promise; public spawn(timeout?: number): Promise; - public on(event: 'spawn' | 'death', listener: (child: ChildProcess) => Awaited): this; - public on(event: 'disconnect' | 'ready' | 'reconnecting', listener: () => Awaited): this; - public on(event: 'error', listener: (error: Error) => Awaited): this; - public on(event: 'message', listener: (message: any) => Awaited): this; - public on(event: string, listener: (...args: any[]) => Awaited): this; + public on(event: 'spawn' | 'death', listener: (child: ChildProcess) => Awaitable): this; + public on(event: 'disconnect' | 'ready' | 'reconnecting', listener: () => Awaitable): this; + public on(event: 'error', listener: (error: Error) => Awaitable): this; + public on(event: 'message', listener: (message: any) => Awaitable): this; + public on(event: string, listener: (...args: any[]) => Awaitable): this; - public once(event: 'spawn' | 'death', listener: (child: ChildProcess) => Awaited): this; - public once(event: 'disconnect' | 'ready' | 'reconnecting', listener: () => Awaited): this; - public once(event: 'error', listener: (error: Error) => Awaited): this; - public once(event: 'message', listener: (message: any) => Awaited): this; - public once(event: string, listener: (...args: any[]) => Awaited): this; + public once(event: 'spawn' | 'death', listener: (child: ChildProcess) => Awaitable): this; + public once(event: 'disconnect' | 'ready' | 'reconnecting', listener: () => Awaitable): this; + public once(event: 'error', listener: (error: Error) => Awaitable): this; + public once(event: 'message', listener: (message: any) => Awaitable): this; + public once(event: string, listener: (...args: any[]) => Awaitable): this; } export class ShardClientUtil { @@ -1722,14 +1722,14 @@ export class ShardClientUtil { public readonly ids: number[]; public mode: ShardingManagerMode; public parentPort: MessagePort | null; - public broadcastEval(fn: (client: Client) => Awaited): Promise[]>; - public broadcastEval(fn: (client: Client) => Awaited, options: { shard: number }): Promise>; + public broadcastEval(fn: (client: Client) => Awaitable): Promise[]>; + public broadcastEval(fn: (client: Client) => Awaitable, options: { shard: number }): Promise>; public broadcastEval( - fn: (client: Client, context: Serialized

) => Awaited, + fn: (client: Client, context: Serialized

) => Awaitable, options: { context: P }, ): Promise[]>; public broadcastEval( - fn: (client: Client, context: Serialized

) => Awaited, + fn: (client: Client, context: Serialized

) => Awaitable, options: { context: P; shard: number }, ): Promise>; public fetchClientValues(prop: string): Promise; @@ -1754,14 +1754,14 @@ export class ShardingManager extends EventEmitter { public totalShards: number | 'auto'; public shardList: number[] | 'auto'; public broadcast(message: unknown): Promise; - public broadcastEval(fn: (client: Client) => Awaited): Promise[]>; - public broadcastEval(fn: (client: Client) => Awaited, options: { shard: number }): Promise>; + public broadcastEval(fn: (client: Client) => Awaitable): Promise[]>; + public broadcastEval(fn: (client: Client) => Awaitable, options: { shard: number }): Promise>; public broadcastEval( - fn: (client: Client, context: Serialized

) => Awaited, + fn: (client: Client, context: Serialized

) => Awaitable, options: { context: P }, ): Promise[]>; public broadcastEval( - fn: (client: Client, context: Serialized

) => Awaited, + fn: (client: Client, context: Serialized

) => Awaitable, options: { context: P; shard: number }, ): Promise>; public createShard(id: number): Shard; @@ -1770,9 +1770,9 @@ export class ShardingManager extends EventEmitter { public respawnAll(options?: MultipleShardRespawnOptions): Promise>; public spawn(options?: MultipleShardSpawnOptions): Promise>; - public on(event: 'shardCreate', listener: (shard: Shard) => Awaited): this; + public on(event: 'shardCreate', listener: (shard: Shard) => Awaitable): this; - public once(event: 'shardCreate', listener: (shard: Shard) => Awaited): this; + public once(event: 'shardCreate', listener: (shard: Shard) => Awaitable): this; } export interface FetchRecommendedShardsOptions { @@ -2230,15 +2230,15 @@ export class WebSocketShard extends EventEmitter { public send(data: unknown, important?: boolean): void; - public on(event: 'ready' | 'resumed' | 'invalidSession', listener: () => Awaited): this; - public on(event: 'close', listener: (event: CloseEvent) => Awaited): this; - public on(event: 'allReady', listener: (unavailableGuilds?: Set) => Awaited): this; - public on(event: string, listener: (...args: any[]) => Awaited): this; + public on(event: 'ready' | 'resumed' | 'invalidSession', listener: () => Awaitable): this; + public on(event: 'close', listener: (event: CloseEvent) => Awaitable): this; + public on(event: 'allReady', listener: (unavailableGuilds?: Set) => Awaitable): this; + public on(event: string, listener: (...args: any[]) => Awaitable): this; - public once(event: 'ready' | 'resumed' | 'invalidSession', listener: () => Awaited): this; - public once(event: 'close', listener: (event: CloseEvent) => Awaited): this; - public once(event: 'allReady', listener: (unavailableGuilds?: Set) => Awaited): this; - public once(event: string, listener: (...args: any[]) => Awaited): this; + public once(event: 'ready' | 'resumed' | 'invalidSession', listener: () => Awaitable): this; + public once(event: 'close', listener: (event: CloseEvent) => Awaitable): this; + public once(event: 'allReady', listener: (unavailableGuilds?: Set) => Awaitable): this; + public once(event: string, listener: (...args: any[]) => Awaitable): this; } export class Widget extends Base { @@ -3232,7 +3232,7 @@ export interface AuditLogChange { new?: APIAuditLogChange['new_value']; } -export type Awaited = T | PromiseLike; +export type Awaitable = T | PromiseLike; export type AwaitMessageComponentOptions = Omit< MessageComponentCollectorOptions,