mirror of
https://github.com/discordeno/discordeno.git
synced 2026-09-18 01:07: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>
59 lines
2.2 KiB
TypeScript
59 lines
2.2 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 { ChannelTypes } from "../../../types/shared.ts";
|
|
|
|
/**
|
|
* Creates a thread without using a message as the thread's point of origin.
|
|
*
|
|
* @param bot - The bot instance to use to make the request.
|
|
* @param channelId - The ID of the channel in which to create the thread.
|
|
* @param options - The parameters to use for the creation of the thread.
|
|
* @returns An instance of the created {@link Channel | Thread}.
|
|
*
|
|
* @remarks
|
|
* Creating a private thread requires the server to be boosted.
|
|
*
|
|
* Fires a _Thread Create_ gateway event.
|
|
*
|
|
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-without-message}
|
|
*/
|
|
export async function startThreadWithoutMessage(
|
|
bot: Bot,
|
|
channelId: bigint,
|
|
options: StartThreadWithoutMessage,
|
|
): Promise<Channel> {
|
|
const result = await bot.rest.runMethod<DiscordChannel>(
|
|
bot.rest,
|
|
"POST",
|
|
bot.constants.routes.THREAD_START_PRIVATE(channelId),
|
|
{
|
|
name: options.name,
|
|
auto_archive_duration: options.autoArchiveDuration,
|
|
rate_limit_per_user: options.rateLimitPerUser,
|
|
type: options.type,
|
|
invitable: options.invitable,
|
|
reason: options.reason,
|
|
},
|
|
);
|
|
|
|
return bot.transformers.channel(bot, {
|
|
channel: result,
|
|
guildId: result.guild_id ? bot.transformers.snowflake(result.guild_id) : undefined,
|
|
});
|
|
}
|
|
|
|
export interface StartThreadWithoutMessage extends WithReason {
|
|
/** 1-100 character thread name */
|
|
name: string;
|
|
/** Duration in minutes to automatically archive the thread after recent activity */
|
|
autoArchiveDuration: 60 | 1440 | 4320 | 10080;
|
|
/** Amount of seconds a user has to wait before sending another message (0-21600) */
|
|
rateLimitPerUser?: number | null;
|
|
/** the type of thread to create */
|
|
type: ChannelTypes.AnnouncementThread | ChannelTypes.PublicThread | ChannelTypes.PrivateThread;
|
|
/** whether non-moderators can add other non-moderators to a thread; only available when creating a private thread */
|
|
invitable?: boolean;
|
|
}
|