GuildPruneMembersOptions

typedef · Source

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

Properties

days

optional

days: number

Number of days of inactivity required to kick

Default: 7

dry

optional

dry: boolean

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

Default: false

count

optional

count: boolean

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

Default: true

roles

optional

roles: Array<RoleResolvable>

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

reason

optional

reason: string

Reason for this prune