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

x/discordeno/helpers/members/pruneMembers.ts>pruneMembers

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

Initiates the process of pruning inactive members.

Parameters

bot: Bot
  • The bot instance to use to make the request.
guildId: BigString
  • The ID of the guild to prune the members of.
options: BeginGuildPrune
  • The parameters for the pruning of members.

Returns

Promise<number | undefined>

A number indicating how many members were pruned.