Files
discordeno/helpers/templates/createGuildTemplate.ts
T
Skillz4Killz 3a5bdce32d feat: helpers support strings in args (#2478)
* fix: helpers support strings in args

* fix: fmt
2022-09-15 20:59:02 -05:00

46 lines
1.5 KiB
TypeScript

import type { Bot } from "../../bot.ts";
import { Template } from "../../transformers/template.ts";
import { DiscordTemplate } from "../../types/discord.ts";
import { BigString } from "../../types/shared.ts";
/**
* Creates a template from a guild.
*
* @param bot - The bot instance to use to make the request.
* @param guildId - The ID of the guild to create the template from.
* @param options - The parameters for the creation of the template.
* @returns An instance of the created {@link Template}.
*
* @remarks
* Requires the `MANAGE_GUILD` permission.
*
* Fires a _Guild Update_ gateway event.
*
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-template}
*/
export async function createGuildTemplate(bot: Bot, guildId: BigString, options: CreateTemplate): Promise<Template> {
if (options.name.length < 1 || options.name.length > 100) {
throw new Error("The name can only be in between 1-100 characters.");
}
if (options.description?.length && options.description.length > 120) {
throw new Error("The description can only be in between 0-120 characters.");
}
const result = await bot.rest.runMethod<DiscordTemplate>(
bot.rest,
"POST",
bot.constants.routes.GUILD_TEMPLATES(guildId),
options,
);
return bot.transformers.template(bot, result);
}
export interface CreateTemplate {
/** Name which the template should have */
name: string;
/** Description of the template */
description?: string;
}