diff --git a/typings/index.d.ts b/typings/index.d.ts index 2bff7f52f..a924fb4fd 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -83,7 +83,7 @@ declare module 'discord.js' { export class Base { constructor(client: Client); public readonly client: Client; - public toJSON(...props: { [key: string]: boolean | string }[]): object; + public toJSON(...props: { [key: string]: boolean | string; }[]): object; public valueOf(): string; } @@ -103,7 +103,7 @@ declare module 'discord.js' { public setInterval(fn: Function, delay: number, ...args: any[]): NodeJS.Timer; public setTimeout(fn: Function, delay: number, ...args: any[]): NodeJS.Timer; public setImmediate(fn: Function, ...args: any[]): NodeJS.Immediate; - public toJSON(...props: { [key: string]: boolean | string }[]): object; + public toJSON(...props: { [key: string]: boolean | string; }[]): object; } class BroadcastDispatcher extends VolumeMixin(StreamDispatcher) { @@ -373,14 +373,14 @@ declare module 'discord.js' { types: PathLike; homepage: string; keywords: string[]; - bugs: { url: string }; - repository: { type: string, url: string }; - browser: { [key: string]: boolean }; - scripts: { [key: string]: string }; - engines: { [key: string]: string }; - dependencies: { [key: string]: string }; - peerDependencies: { [key: string]: string }; - devDependencies: { [key: string]: string }; + bugs: { url: string; }; + repository: { type: string, url: string; }; + browser: { [key: string]: boolean; }; + scripts: { [key: string]: string; }; + engines: { [key: string]: string; }; + dependencies: { [key: string]: string; }; + peerDependencies: { [key: string]: string; }; + devDependencies: { [key: string]: string; }; [key: string]: any; }; browser: boolean; @@ -738,15 +738,15 @@ declare module 'discord.js' { public equals(guild: Guild): boolean; public fetch(): Promise; public fetchAuditLogs(options?: GuildAuditLogsFetchOptions): Promise; - public fetchBan(user: UserResolvable): Promise<{ user: User, reason: string }>; - public fetchBans(): Promise>; + public fetchBan(user: UserResolvable): Promise<{ user: User; reason: string; }>; + public fetchBans(): Promise>; public fetchEmbed(): Promise; public fetchIntegrations(): Promise>; public fetchInvites(): Promise>; public fetchVanityCode(): Promise; public fetchVoiceRegions(): Promise>; public fetchWebhooks(): Promise>; - public iconURL(options?: ImageURLOptions & { dynamic?: boolean }): string | null; + public iconURL(options?: ImageURLOptions & { dynamic?: boolean; }): string | null; public leave(): Promise; public member(user: UserResolvable): GuildMember | null; public setAFKChannel(afkChannel: ChannelResolvable | null, reason?: string): Promise; @@ -826,11 +826,11 @@ declare module 'discord.js' { public equals(channel: GuildChannel): boolean; public fetchInvites(): Promise>; public lockPermissions(): Promise; - public overwritePermissions(options?: { permissionOverwrites?: OverwriteResolvable[] | Collection, reason?: string }): Promise; + public overwritePermissions(options?: { permissionOverwrites?: OverwriteResolvable[] | Collection, reason?: string; }): Promise; public permissionsFor(memberOrRole: GuildMemberResolvable | RoleResolvable): Readonly | null; public setName(name: string, reason?: string): Promise; - public setParent(channel: GuildChannel | Snowflake, options?: { lockPermissions?: boolean, reason?: string }): Promise; - public setPosition(position: number, options?: { relative?: boolean, reason?: string }): Promise; + public setParent(channel: GuildChannel | Snowflake, options?: { lockPermissions?: boolean; reason?: string; }): Promise; + public setPosition(position: number, options?: { relative?: boolean; reason?: string; }): Promise; public setTopic(topic: string, reason?: string): Promise; public updateOverwrite(userOrRole: RoleResolvable | UserResolvable, options: PermissionOverwriteOption, reason?: string): Promise; } @@ -893,7 +893,7 @@ declare module 'discord.js' { public createDM(): Promise; public deleteDM(): Promise; public edit(data: GuildMemberEditData, reason?: string): Promise; - public hasPermission(permission: PermissionResolvable, options?: { checkAdmin?: boolean; checkOwner?: boolean }): boolean; + public hasPermission(permission: PermissionResolvable, options?: { checkAdmin?: boolean; checkOwner?: boolean; }): boolean; public kick(reason?: string): Promise; public permissionsIn(channel: ChannelResolvable): Readonly; public setNickname(nickname: string, reason?: string): Promise; @@ -998,7 +998,7 @@ declare module 'discord.js' { public reference: MessageReference | null; public awaitReactions(filter: CollectorFilter, options?: AwaitReactionsOptions): Promise>; public createReactionCollector(filter: CollectorFilter, options?: ReactionCollectorOptions): ReactionCollector; - public delete(options?: { timeout?: number, reason?: string }): Promise; + public delete(options?: { timeout?: number; reason?: string; }): Promise; public edit(content: StringResolvable, options?: MessageEditOptions | MessageEmbed): Promise; public edit(options: MessageEditOptions | MessageEmbed | APIMessage): Promise; public equals(message: Message, rawData: object): boolean; @@ -1007,11 +1007,11 @@ declare module 'discord.js' { public pin(): Promise; public react(emoji: EmojiIdentifierResolvable): Promise; public reply(content?: StringResolvable, options?: MessageOptions | MessageAdditions): Promise; - public reply(content?: StringResolvable, options?: MessageOptions & { split?: false } | MessageAdditions): Promise; - public reply(content?: StringResolvable, options?: MessageOptions & { split: true | SplitOptions } | MessageAdditions): Promise; + public reply(content?: StringResolvable, options?: MessageOptions & { split?: false; } | MessageAdditions): Promise; + public reply(content?: StringResolvable, options?: MessageOptions & { split: true | SplitOptions; } | MessageAdditions): Promise; public reply(options?: MessageOptions | MessageAdditions | APIMessage): Promise; - public reply(options?: MessageOptions & { split?: false } | MessageAdditions | APIMessage): Promise; - public reply(options?: MessageOptions & { split: true | SplitOptions } | MessageAdditions | APIMessage): Promise; + public reply(options?: MessageOptions & { split?: false; } | MessageAdditions | APIMessage): Promise; + public reply(options?: MessageOptions & { split: true | SplitOptions; } | MessageAdditions | APIMessage): Promise; public suppressEmbeds(suppress?: boolean): Promise; public toJSON(): object; public toString(): string; @@ -1138,7 +1138,7 @@ declare module 'discord.js' { public update(options: PermissionOverwriteOption, reason?: string): Promise; public delete(reason?: string): Promise; public toJSON(): object; - public static resolveOverwriteOptions(options: ResolvedOverwriteOptions, initialPermissions: { allow?: PermissionResolvable, deny?: PermissionResolvable }): ResolvedOverwriteOptions; + public static resolveOverwriteOptions(options: ResolvedOverwriteOptions, initialPermissions: { allow?: PermissionResolvable; deny?: PermissionResolvable; }): ResolvedOverwriteOptions; public static resolve(overwrite: OverwriteResolvable, guild: Guild): RawOverwriteData; } @@ -1242,7 +1242,7 @@ declare module 'discord.js' { public setMentionable(mentionable: boolean, reason?: string): Promise; public setName(name: string, reason?: string): Promise; public setPermissions(permissions: PermissionResolvable, reason?: string): Promise; - public setPosition(position: number, options?: { relative?: boolean; reason?: string }): Promise; + public setPosition(position: number, options?: { relative?: boolean; reason?: string; }): Promise; public toJSON(): object; public toString(): string; @@ -1410,7 +1410,7 @@ declare module 'discord.js' { public nsfw: boolean; public rateLimitPerUser: number; public topic: string | null; - public createWebhook(name: string, options?: { avatar?: BufferResolvable | Base64Resolvable, reason?: string }): Promise; + public createWebhook(name: string, options?: { avatar?: BufferResolvable | Base64Resolvable; reason?: string; }): Promise; public setNSFW(nsfw: boolean, reason?: string): Promise; public setRateLimitPerUser(rateLimitPerUser: number, reason?: string): Promise; public fetchWebhooks(): Promise>; @@ -1421,7 +1421,7 @@ declare module 'discord.js' { public messages: MessageManager; public nsfw: boolean; public topic: string | null; - public createWebhook(name: string, options?: { avatar?: BufferResolvable | Base64Resolvable, reason?: string }): Promise; + public createWebhook(name: string, options?: { avatar?: BufferResolvable | Base64Resolvable; reason?: string; }): Promise; public setNSFW(nsfw: boolean, reason?: string): Promise; public fetchWebhooks(): Promise>; } @@ -1442,10 +1442,10 @@ declare module 'discord.js' { public system?: boolean; public readonly tag: string; public username: string; - public avatarURL(options?: ImageURLOptions & { dynamic?: boolean }): string | null; + public avatarURL(options?: ImageURLOptions & { dynamic?: boolean; }): string | null; public createDM(): Promise; public deleteDM(): Promise; - public displayAvatarURL(options?: ImageURLOptions & { dynamic?: boolean }): string; + public displayAvatarURL(options?: ImageURLOptions & { dynamic?: boolean; }): string; public equals(user: User): boolean; public fetch(): Promise; public toString(): string; @@ -1462,7 +1462,7 @@ declare module 'discord.js' { public static convertToBuffer(ab: ArrayBuffer | string): Buffer; public static delayFor(ms: number): Promise; public static discordSort(collection: Collection): Collection; - public static escapeMarkdown(text: string, options?: { codeBlock?: boolean, inlineCode?: boolean, bold?: boolean, italic?: boolean, underline?: boolean, strikethrough?: boolean, spoiler?: boolean, inlineCodeContent?: boolean, codeBlockContent?: boolean }): string; + public static escapeMarkdown(text: string, options?: { codeBlock?: boolean; inlineCode?: boolean; bold?: boolean; italic?: boolean; underline?: boolean; strikethrough?: boolean; spoiler?: boolean; inlineCodeContent?: boolean; codeBlockContent?: boolean; }): string; public static escapeCodeBlock(text: string): string; public static escapeInlineCode(text: string): string; public static escapeBold(text: string): string; @@ -1472,10 +1472,10 @@ declare module 'discord.js' { public static escapeSpoiler(text: string): string; public static cleanCodeBlockContent(text: string): string; public static fetchRecommendedShards(token: string, guildsPerShard?: number): Promise; - public static flatten(obj: object, ...props: { [key: string]: boolean | string }[]): object; + public static flatten(obj: object, ...props: { [key: string]: boolean | string; }[]): object; public static idToBinary(num: Snowflake): string; - public static makeError(obj: { name: string, message: string, stack: string }): Error; - public static makePlainError(err: Error): { name: string, message: string, stack: string }; + public static makeError(obj: { name: string; message: string; stack: string; }): Error; + public static makePlainError(err: Error): { name: string; message: string; stack: string; }; public static mergeDefault(def: object, given: object): object; public static moveElementInArray(array: any[], element: any, newIndex: number, offset?: boolean): number; public static parseEmoji(text: string): { animated: boolean; name: string; id: string | null; } | null; @@ -1488,7 +1488,7 @@ declare module 'discord.js' { sorted: Collection, route: object, reason?: string - ): Promise<{ id: Snowflake; position: number }[]>; + ): Promise<{ id: Snowflake; position: number; }[]>; public static splitMessage(text: StringResolvable, options?: SplitOptions): string[]; public static str2ab(str: string): ArrayBuffer; } @@ -1592,7 +1592,7 @@ declare module 'discord.js' { class VoiceReceiver extends EventEmitter { constructor(connection: VoiceConnection); - public createStream(user: UserResolvable, options?: { mode?: 'opus' | 'pcm', end?: 'silence' | 'manual' }): Readable; + public createStream(user: UserResolvable, options?: { mode?: 'opus' | 'pcm'; end?: 'silence' | 'manual'; }): Readable; public on(event: 'debug', listener: (error: Error | string) => void): this; public on(event: string, listener: Function): this; @@ -1639,7 +1639,7 @@ declare module 'discord.js' { } class VolumeInterface extends EventEmitter { - constructor(options?: { volume?: number }) + constructor(options?: { volume?: number; }); public readonly volume: number; public readonly volumeDecibels: number; public readonly volumeEditable: boolean; @@ -1736,7 +1736,7 @@ declare module 'discord.js' { private identifyResume(): void; private _send(data: object): void; private processQueue(): void; - private destroy(destroyOptions?: { closeCode?: number; reset?: boolean; emit?: boolean; log?: boolean }): void; + private destroy(destroyOptions?: { closeCode?: number; reset?: boolean; emit?: boolean; log?: boolean; }): void; private _cleanupConnection(): void; private _emitDestroyed(): void; @@ -1790,7 +1790,7 @@ declare module 'discord.js' { public cache: Collection; public cacheType: Collection; public readonly client: Client; - public add(data: any, cache?: boolean, { id, extras }?: { id: K, extras: any[] }): Holds; + public add(data: any, cache?: boolean, { id, extras }?: { id: K; extras: any[]; }): Holds; public remove(key: K): void; public resolve(resolvable: R): Holds | null; public resolveID(resolvable: R): K | null; @@ -1816,9 +1816,9 @@ declare module 'discord.js' { export class GuildChannelManager extends BaseManager { constructor(guild: Guild, iterable?: Iterable); public guild: Guild; - public create(name: string, options: GuildCreateChannelOptions & { type: 'voice' }): Promise; - public create(name: string, options: GuildCreateChannelOptions & { type: 'category' }): Promise; - public create(name: string, options?: GuildCreateChannelOptions & { type?: 'text' }): Promise; + public create(name: string, options: GuildCreateChannelOptions & { type: 'voice'; }): Promise; + public create(name: string, options: GuildCreateChannelOptions & { type: 'category'; }): Promise; + public create(name: string, options?: GuildCreateChannelOptions & { type?: 'text'; }): Promise; public create(name: string, options: GuildCreateChannelOptions): Promise; } @@ -1847,14 +1847,14 @@ declare module 'discord.js' { public ban(user: UserResolvable, options?: BanOptions): Promise; public fetch(options: UserResolvable | FetchMemberOptions): Promise; public fetch(options?: FetchMembersOptions): Promise>; - public prune(options: GuildPruneMembersOptions & { dry?: false, count: false }): Promise; + public prune(options: GuildPruneMembersOptions & { dry?: false; count: false; }): Promise; public prune(options?: GuildPruneMembersOptions): Promise; public unban(user: UserResolvable, reason?: string): Promise; } export class GuildManager extends BaseManager { constructor(client: Client, iterable?: Iterable); - public create(name: string, options?: { region?: string, icon: BufferResolvable | Base64Resolvable | null }): Promise; + public create(name: string, options?: { region?: string; icon: BufferResolvable | Base64Resolvable | null; }): Promise; } export class MessageManager extends BaseManager { @@ -1880,7 +1880,7 @@ declare module 'discord.js' { export class ReactionUserManager extends BaseManager { constructor(client: Client, iterable: Iterable | undefined, reaction: MessageReaction); public reaction: MessageReaction; - public fetch(options?: { limit?: number, after?: Snowflake, before?: Snowflake }): Promise>; + public fetch(options?: { limit?: number; after?: Snowflake; before?: Snowflake; }): Promise>; public remove(user?: UserResolvable): Promise; } @@ -1890,7 +1890,7 @@ declare module 'discord.js' { public readonly highest: Role; public guild: Guild; - public create(options?: { data?: RoleData, reason?: string }): Promise; + public create(options?: { data?: RoleData; reason?: string; }): Promise; public fetch(id: Snowflake, cache?: boolean): Promise; public fetch(id?: Snowflake, cache?: boolean): Promise; } @@ -1924,11 +1924,11 @@ declare module 'discord.js' { lastPinTimestamp: number | null; readonly lastPinAt: Date; send(content?: StringResolvable, options?: MessageOptions | MessageAdditions): Promise; - send(content?: StringResolvable, options?: MessageOptions & { split?: false } | MessageAdditions): Promise; - send(content?: StringResolvable, options?: MessageOptions & { split: true | SplitOptions } | MessageAdditions): Promise; + send(content?: StringResolvable, options?: MessageOptions & { split?: false; } | MessageAdditions): Promise; + send(content?: StringResolvable, options?: MessageOptions & { split: true | SplitOptions; } | MessageAdditions): Promise; send(options?: MessageOptions | MessageAdditions | APIMessage): Promise; - send(options?: MessageOptions & { split?: false } | MessageAdditions | APIMessage): Promise; - send(options?: MessageOptions & { split: true | SplitOptions } | MessageAdditions | APIMessage): Promise; + send(options?: MessageOptions & { split?: false; } | MessageAdditions | APIMessage): Promise; + send(options?: MessageOptions & { split: true | SplitOptions; } | MessageAdditions | APIMessage): Promise; } interface TextBasedChannelFields extends PartialTextBasedChannelFields { @@ -1951,10 +1951,10 @@ declare module 'discord.js' { readonly url: string; delete(reason?: string): Promise; edit(options: WebhookEditData): Promise; - send(content?: StringResolvable, options?: WebhookMessageOptions & { split?: false } | MessageAdditions): Promise; - send(content?: StringResolvable, options?: WebhookMessageOptions & { split: true | SplitOptions } | MessageAdditions): Promise; - send(options?: WebhookMessageOptions & { split?: false } | MessageAdditions | APIMessage): Promise; - send(options?: WebhookMessageOptions & { split: true | SplitOptions } | MessageAdditions | APIMessage): Promise; + send(content?: StringResolvable, options?: WebhookMessageOptions & { split?: false; } | MessageAdditions): Promise; + send(content?: StringResolvable, options?: WebhookMessageOptions & { split: true | SplitOptions; } | MessageAdditions): Promise; + send(options?: WebhookMessageOptions & { split?: false; } | MessageAdditions | APIMessage): Promise; + send(options?: WebhookMessageOptions & { split: true | SplitOptions; } | MessageAdditions | APIMessage): Promise; sendSlackMessage(body: object): Promise; } @@ -2457,11 +2457,11 @@ declare module 'discord.js' { color?: ColorResolvable; fields?: EmbedField[]; files?: (MessageAttachment | string | FileOptions)[]; - author?: Partial & { icon_url?: string; proxy_icon_url?: string }; - thumbnail?: Partial & { proxy_url?: string }; - image?: Partial & { proxy_url?: string }; - video?: Partial & { proxy_url?: string }; - footer?: Partial & { icon_url?: string; proxy_icon_url?: string }; + author?: Partial & { icon_url?: string; proxy_icon_url?: string; }; + thumbnail?: Partial & { proxy_url?: string; }; + image?: Partial & { proxy_url?: string; }; + video?: Partial & { proxy_url?: string; }; + footer?: Partial & { icon_url?: string; proxy_icon_url?: string; }; } interface MessageEmbedAuthor { @@ -2629,8 +2629,8 @@ declare module 'discord.js' { partial: true; fetch(): Promise; } & { - [K in keyof Omit]: T[K] | null; - }; + [K in keyof Omit]: T[K] | null; + }; interface PartialMessage extends Partialize {} interface PartialChannel extends Partialize {}