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

types: make channel types a lot stricter (#7120)

Browse Source
This commit is contained in:
Antonio Román
2021-12-22 11:13:01 +01:00
committed by GitHub
parent 6bb03f2c34
commit 7b65a04cb1
2 changed files with 114 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
typings/index.test-d.ts
View File

@@ -37,13 +37,11 @@ import {
DMChannel,
Guild,
GuildApplicationCommandManager,
GuildChannel,
GuildChannelManager,
GuildEmoji,
GuildEmojiManager,
GuildMember,
GuildResolvable,
GuildTextBasedChannel,
Intents,
Interaction,
InteractionCollector,
@@ -72,7 +70,12 @@ import {
StageChannel,
StoreChannel,
TextBasedChannelFields,
TextBasedChannels,
TextBasedChannel,
TextBasedChannelTypes,
VoiceBasedChannel,
GuildBasedChannel,
NonThreadGuildBasedChannel,
GuildTextBasedChannel,
TextChannel,
ThreadChannel,
ThreadMember,
@@ -89,6 +92,7 @@ import {
Emoji,
MessageActionRowComponent,
MessageSelectMenu,
PartialDMChannel,
} from '.';
import type { ApplicationCommandOptionTypes } from './enums';
import { expectAssignable, expectDeprecated, expectNotAssignable, expectNotType, expectType } from 'tsd';
@@ -542,7 +546,7 @@ client.on('messageCreate', async message => {
expectType<GuildMember | null>(message.member);
}
expectType<TextBasedChannels>(message.channel);
expectType<TextBasedChannel>(message.channel);
expectNotType<GuildTextBasedChannel>(message.channel);
// @ts-expect-error
@@ -890,7 +894,7 @@ declare const typing: Typing;
expectType<PartialUser>(typing.user);
if (typing.user.partial) expectType<null>(typing.user.username);
expectType<TextBasedChannels>(typing.channel);
expectType<TextBasedChannel>(typing.channel);
if (typing.channel.partial) expectType<undefined>(typing.channel.lastMessageId);
expectType<GuildMember | null>(typing.member);
@@ -1076,7 +1080,7 @@ client.on('interactionCreate', async interaction => {
expectAssignable<CommandInteraction>(interaction);
expectType<Promise<Message<true>>>(interaction.reply({ fetchReply: true }));
expectType<GuildChannel | ThreadChannel>(interaction.options.getChannel('test', true));
expectType<GuildBasedChannel>(interaction.options.getChannel('test', true));
expectType<Role>(interaction.options.getRole('test', true));
} else {
// @ts-expect-error
@@ -1086,9 +1090,7 @@ client.on('interactionCreate', async interaction => {
expectType<APIInteractionDataResolvedGuildMember | GuildMember | null>(interaction.options.getMember('test'));
expectType<APIInteractionDataResolvedGuildMember | GuildMember>(interaction.options.getMember('test', true));
expectType<GuildChannel | ThreadChannel | APIInteractionDataResolvedChannel>(
interaction.options.getChannel('test', true),
);
expectType<GuildBasedChannel | APIInteractionDataResolvedChannel>(interaction.options.getChannel('test', true));
expectType<APIRole | Role>(interaction.options.getRole('test', true));
}
@@ -1229,3 +1231,23 @@ expectType<Promise<User | undefined>>(
// @ts-expect-error Invalid audit log ID
guild.fetchAuditLogs({ type: 2000 }).then(al => al.entries.first()?.target),
);
declare const TextBasedChannel: TextBasedChannel;
declare const TextBasedChannelTypes: TextBasedChannelTypes;
declare const VoiceBasedChannel: VoiceBasedChannel;
declare const GuildBasedChannel: GuildBasedChannel;
declare const NonThreadGuildBasedChannel: NonThreadGuildBasedChannel;
declare const GuildTextBasedChannel: GuildTextBasedChannel;
expectType<DMChannel | PartialDMChannel | NewsChannel | TextChannel | ThreadChannel>(TextBasedChannel);
expectType<'DM' | 'GUILD_NEWS' | 'GUILD_TEXT' | 'GUILD_PUBLIC_THREAD' | 'GUILD_PRIVATE_THREAD' | 'GUILD_NEWS_THREAD'>(
TextBasedChannelTypes,
);
expectType<StageChannel | VoiceChannel>(VoiceBasedChannel);
expectType<CategoryChannel | NewsChannel | StageChannel | StoreChannel | TextChannel | ThreadChannel | VoiceChannel>(
GuildBasedChannel,
);
expectType<CategoryChannel | NewsChannel | StageChannel | StoreChannel | TextChannel | VoiceChannel>(
NonThreadGuildBasedChannel,
);
expectType<NewsChannel | TextChannel | ThreadChannel>(GuildTextBasedChannel);