Results

Namespace

Type

Options to pass when executing a guild prune operation with discord.Guild.beginPrune.

Hierarchy

  • IPruneOptions <-- You are here!

Index

Properties

Optional computePruneCount

computePruneCount: undefined | false | true

If set to false, the guild prune action will be scheduled and the call will return immediately.

If true (default), the call will wait for the completion of the prune operation and return the total number of users pruned.

Optional days

days: undefined | number

The maximum number of days a member must be inactive for them to be considered for pruning.

Acceptable values are 1 thru 30, and the default is 7 days.

For example, if you choose 30, members who were active within the past 30 days will not be considered for pruning.

Optional includeRoles

includeRoles: Array<Snowflake>

A list of roles to be included in the pruning process. By default, members with roles are ignored. Specifying a role here will include members with only the roles specified for pruning.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc