mirror of
https://github.com/discordeno/discordeno.git
synced 2026-09-17 16:57:22 +00:00
LTS20050703andSkillz4Killz
16f109ad43
* type WithReason<T> = T & { reason?: string }
* deno fmt (1.25.2)
* WithReason: jsdoc comments for reason
Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>
* deno fmt
* types: WithReason type -> WithReason interface
* Fix: Some helpers missing support for reason
Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>
85 lines
3.4 KiB
TypeScript
85 lines
3.4 KiB
TypeScript
import type { Bot } from "../../bot.ts";
|
|
import { WithReason } from "../../mod.ts";
|
|
import { Channel } from "../../transformers/channel.ts";
|
|
import { DiscordChannel } from "../../types/discord.ts";
|
|
import { OverwriteReadable } from "../../types/discordeno.ts";
|
|
import { ChannelTypes } from "../../types/shared.ts";
|
|
|
|
/**
|
|
* Creates a channel within a guild.
|
|
*
|
|
* @param bot - The bot instance to use to make the request.
|
|
* @param guildId - The ID of the guild to create the channel within.
|
|
* @param options - The parameters for the creation of the channel.
|
|
* @returns An instance of the created {@link Channel}.
|
|
*
|
|
* @remarks
|
|
* Requires the `MANAGE_CHANNELS` permission.
|
|
*
|
|
* If setting permission overwrites, only the permissions the bot user has in the guild can be allowed or denied.
|
|
*
|
|
* Setting the `MANAGE_ROLES` permission is only possible for guild administrators.
|
|
*
|
|
* Fires a _Channel Create_ gateway event.
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-channel}
|
|
*/
|
|
export async function createChannel(bot: Bot, guildId: bigint, options?: CreateGuildChannel): Promise<Channel> {
|
|
// BITRATE IS IN THOUSANDS SO IF USER PROVIDES 32 WE CONVERT TO 32000
|
|
if (options?.bitrate && options.bitrate < 1000) options.bitrate *= 1000;
|
|
|
|
const result = await bot.rest.runMethod<DiscordChannel>(
|
|
bot.rest,
|
|
"POST",
|
|
bot.constants.routes.GUILD_CHANNELS(guildId),
|
|
options
|
|
? {
|
|
name: options.name,
|
|
topic: options.topic,
|
|
bitrate: options.bitrate,
|
|
user_limit: options.userLimit,
|
|
rate_limit_per_user: options.rateLimitPerUser,
|
|
position: options.position,
|
|
parent_id: options.parentId?.toString(),
|
|
nsfw: options.nsfw,
|
|
permission_overwrites: options?.permissionOverwrites?.map((overwrite) => ({
|
|
id: overwrite.id.toString(),
|
|
type: overwrite.type,
|
|
allow: overwrite.allow ? bot.utils.calculateBits(overwrite.allow) : null,
|
|
deny: overwrite.deny ? bot.utils.calculateBits(overwrite.deny) : null,
|
|
})),
|
|
type: options?.type || ChannelTypes.GuildText,
|
|
reason: options.reason,
|
|
default_auto_archive_duration: options?.defaultAutoArchiveDuration,
|
|
}
|
|
: {},
|
|
);
|
|
|
|
return bot.transformers.channel(bot, { channel: result, guildId });
|
|
}
|
|
|
|
export interface CreateGuildChannel extends WithReason {
|
|
/** Channel name (1-100 characters) */
|
|
name: string;
|
|
/** The type of channel */
|
|
type?: ChannelTypes;
|
|
/** Channel topic (0-1024 characters) */
|
|
topic?: string;
|
|
/** The bitrate (in bits) of the voice channel (voice only) */
|
|
bitrate?: number;
|
|
/** The user limit of the voice channel (voice only) */
|
|
userLimit?: number;
|
|
/** Amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission `manage_messages` or `manage_channel`, are unaffected */
|
|
rateLimitPerUser?: number;
|
|
/** Sorting position of the channel */
|
|
position?: number;
|
|
/** The channel's permission overwrites */
|
|
permissionOverwrites?: OverwriteReadable[];
|
|
/** Id of the parent category for a channel */
|
|
parentId?: bigint;
|
|
/** Whether the channel is nsfw */
|
|
nsfw?: boolean;
|
|
/** Default duration (in minutes) that clients (not the API) use for newly created threads in this channel, to determine when to automatically archive the thread after the last activity */
|
|
defaultAutoArchiveDuration?: number;
|
|
}
|