Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

types(GuildChannelManager): correct fetch return type #8549

Merged
merged 12 commits into from Sep 11, 2022
Merged

types(GuildChannelManager): correct fetch return type #8549

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5bcb82a
types(GuildChannelManager): correct `fetch` return type
RedGuy12 Aug 12, 2022
281811c
fix(ci): fix the types tests
RedGuy12 Aug 23, 2022
0b5c130
fix: fix the docs
RedGuy12 Aug 23, 2022
abaea45
Merge branch 'main' of https://github.com/discordjs/discord.js into f…
RedGuy12 Aug 23, 2022
140f60e
Update packages/discord.js/src/managers/GuildChannelManager.js
RedGuy12 Aug 23, 2022
3366f12
Merge branch 'main' into fetch-channels-threads
RedGuy12 Sep 2, 2022
a25a781
Merge branch 'main' into fetch-channels-threads
RedGuy12 Sep 2, 2022
44ab439
types: allow channels in the collection to be null
RedGuy12 Sep 5, 2022
7f0e9c8
style: run prettier
RedGuy12 Sep 5, 2022
945157c
test: fix types again
RedGuy12 Sep 5, 2022
2ceefc5
style: run prettier
RedGuy12 Sep 5, 2022
4547153
Merge branch 'main' into fetch-channels-threads
kodiakhq[bot] Sep 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/discord.js/src/managers/GuildChannelManager.js
View file
Open in desktop
Expand Up @@ -317,7 +317,7 @@ class GuildChannelManager extends CachedManager {
* Obtains one or more guild channels from Discord, or the channel cache if they're already available.
* @param {Snowflake} [id] The channel's id
* @param {BaseFetchOptions} [options] Additional options for this fetch
* @returns {Promise<?GuildChannel|Collection<Snowflake, GuildChannel>>}
* @returns {Promise<?GuildChannel|ThreadChannel|Collection<Snowflake, ?GuildChannel>>}
* @example
* // Fetch all channels from the guild (excluding threads)
* message.guild.channels.fetch()
Expand Down
7 changes: 5 additions & 2 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Expand Up @@ -3376,8 +3376,11 @@ export class GuildChannelManager extends CachedManager<Snowflake, GuildBasedChan
public create(options: GuildChannelCreateOptions): Promise<TextChannel>;
public createWebhook(options: WebhookCreateOptions): Promise<Webhook>;
public edit(channel: GuildChannelResolvable, data: GuildChannelEditOptions): Promise<GuildChannel>;
public fetch(id: Snowflake, options?: BaseFetchOptions): Promise<NonThreadGuildBasedChannel | null>;
public fetch(id?: undefined, options?: BaseFetchOptions): Promise<Collection<Snowflake, NonThreadGuildBasedChannel>>;
public fetch(id: Snowflake, options?: BaseFetchOptions): Promise<GuildBasedChannel | null>;
public fetch(
id?: undefined,
options?: BaseFetchOptions,
): Promise<Collection<Snowflake, NonThreadGuildBasedChannel | null>>;
public fetchWebhooks(channel: GuildChannelResolvable): Promise<Collection<Snowflake, Webhook>>;
public setPosition(
channel: GuildChannelResolvable,
Expand Down
6 changes: 3 additions & 3 deletions packages/discord.js/typings/index.test-d.ts
View file
Open in desktop
Expand Up @@ -1187,9 +1187,9 @@ declare const guildChannelManager: GuildChannelManager;
expectType<Promise<NewsChannel>>(guildChannelManager.create({ name: 'name', type: ChannelType.GuildNews }));
expectType<Promise<StageChannel>>(guildChannelManager.create({ name: 'name', type: ChannelType.GuildStageVoice }));

expectType<Promise<Collection<Snowflake, AnyChannel>>>(guildChannelManager.fetch());
expectType<Promise<Collection<Snowflake, AnyChannel>>>(guildChannelManager.fetch(undefined, {}));
expectType<Promise<AnyChannel | null>>(guildChannelManager.fetch('0'));
expectType<Promise<Collection<Snowflake, AnyChannel | null>>>(guildChannelManager.fetch());
expectType<Promise<Collection<Snowflake, AnyChannel | null>>>(guildChannelManager.fetch(undefined, {}));
expectType<Promise<GuildBasedChannel | null>>(guildChannelManager.fetch('0'));

const channel = guildChannelManager.cache.first()!;

Expand Down