interface GuildPruneMembersOptions

export interface GuildPruneMembersOptions

Options used for pruning guild members. It's recommended to set options.count to false for large guilds.

optional
count? : boolean

Whether or not to return the number of users that have been kicked.

optional
days? : number

Number of days of inactivity required to kick

optional
dry? : boolean

Get the number of users that will be kicked, without actually kicking them

optional
reason? : string

Reason for this prune

optional
roles? : RoleResolvable[]

Array of roles to bypass the "...and no roles" constraint when pruning