Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PruneOptions

Options for a guild prune operation

Hierarchy

Index

Properties

Optional computePruneCount

computePruneCount: undefined | number

Whether the prune operation will return the number of members pruned. Discouraged for large guilds

default

true

Optional days

days: undefined | number

The number of days to count prune for (1 or more)

default

7

Optional includeRoles

includeRoles: Snowflake[]

By default, prune will not remove users with roles. You can optionally include specific roles in your prune by providing this field with an array of role IDs to include in the prune.

default

[]

Generated using TypeDoc