discordjs/discord.js
2
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2024-07-08 01:51:19 +12:00
Code Issues Packages Projects Releases Wiki Activity

refactor(GuildChannelManager): improve addFollower errors (#10277)

Browse source 
refactor(GuildChannelManager): improve errors

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
René 2024-05-17 14:14:03 +01:00 committed by GitHub
parent 92c1a511dc
commit 555961b3b8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
packages/discord.js/src/managers/GuildChannelManager.js
View file

@ -98,17 +98,29 @@ class GuildChannelManager extends CachedManager {
return super.resolveId(channel);
}
/**
* Data that can be resolved to a News Channel object. This can be:
* * A NewsChannel object
* * A Snowflake
* @typedef {NewsChannel|Snowflake} NewsChannelResolvable
*/
/**
* Adds the target channel to a channel's followers.
* @param {NewsChannel|Snowflake} channel The channel to follow
* @param {NewsChannelResolvable} channel The channel to follow
* @param {TextChannelResolvable} targetChannel The channel where published announcements will be posted at
* @param {string} [reason] Reason for creating the webhook
* @returns {Promise<Snowflake>} Returns created target webhook id.
*/
async addFollower(channel, targetChannel, reason) {
const channelId = this.resolveId(channel);
if (!channelId) {
throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'channel', 'NewsChannelResolvable');
}
const targetChannelId = this.resolveId(targetChannel);
if (!channelId || !targetChannelId) throw new Error(ErrorCodes.GuildChannelResolve);
if (!targetChannelId) {
throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'targetChannel', 'TextChannelResolvable');
}
const { webhook_id } = await this.client.rest.post(Routes.channelFollowers(channelId), {
body: { webhook_channel_id: targetChannelId },
reason,

4
packages/discord.js/typings/index.d.ts vendored
View file

@ -2464,6 +2464,8 @@ export class NewsChannel extends BaseGuildTextChannel {
public addFollower(channel: TextChannelResolvable, reason?: string): Promise<NewsChannel>;
}
export type NewsChannelResolvable = NewsChannel | Snowflake;
export class OAuth2Guild extends BaseGuild {
private constructor(client: Client<true>, data: RawOAuth2GuildData);
public owner: boolean;
@ -4219,7 +4221,7 @@ export class GuildChannelManager extends CachedManager<Snowflake, GuildBasedChan
public guild: Guild;
public addFollower(
channel: NewsChannel | Snowflake,
channel: NewsChannelResolvable,
targetChannel: TextChannelResolvable,
reason?: string,
): Promise<Snowflake>;