Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/discordeno/helpers/guilds/mod.ts>getPruneCount

Discord API library for Deno
discordeno/discordeno
Popular
Go to Latest
function getPruneCount
import { getPruneCount } from "https://deno.land/x/discordeno@17.0.0/helpers/guilds/mod.ts";

Gets the number of members that would be kicked from a guild during pruning.

Parameters

bot: Bot
  • The bot instance used to make the request
guildId: BigString
  • The ID of the guild to get the prune count of.
optional
options: GetGuildPruneCountQuery
  • The parameters for the fetching of the prune count.

Returns

Promise<number>

A number indicating the number of members that would be kicked.