Files
discordeno/helpers/guilds/leaveGuild.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

18 lines
547 B
TypeScript

import type { Bot } from "../../bot.ts";
import { BigString } from "../../types/shared.ts";
/**
* Leaves a guild.
*
* @param bot - The bot instance used to make the request
* @param guildId - The ID of the guild to leave.
*
* @remarks
* Fires a _Guild Delete_ event.
*
* @see {@link https://discord.com/developers/docs/resources/user#leave-guild}
*/
export async function leaveGuild(bot: Bot, guildId: BigString): Promise<void> {
return await bot.rest.runMethod<void>(bot.rest, "DELETE", bot.constants.routes.GUILD_LEAVE(guildId));
}