Class Sweepers

constructor

• new Sweepers(client: Client<true>, options: SweeperOptions): Sweepers

  Parameters

  • client: Client<true>
  • options: SweeperOptions

  Returns Sweepers

Readonlyclient

intervals

options

sweepApplicationCommands

• sweepApplicationCommands(
      filter: CollectionSweepFilter<string, ApplicationCommand<{}>>,
  ): number

  Parameters

  • filter: CollectionSweepFilter<string, ApplicationCommand<{}>>

  Returns number

sweepAutoModerationRules

• sweepAutoModerationRules(
      filter: CollectionSweepFilter<string, AutoModerationRule>,
  ): number

  Parameters

  • filter: CollectionSweepFilter<string, AutoModerationRule>

  Returns number

sweepBans

• sweepBans(filter: CollectionSweepFilter<string, GuildBan>): number

  Parameters

  • filter: CollectionSweepFilter<string, GuildBan>

  Returns number

sweepEmojis

• sweepEmojis(filter: CollectionSweepFilter<string, GuildEmoji>): number

  Parameters

  • filter: CollectionSweepFilter<string, GuildEmoji>

  Returns number

sweepEntitlements

• sweepEntitlements(filter: CollectionSweepFilter<string, Entitlement>): number

  Parameters

  • filter: CollectionSweepFilter<string, Entitlement>

  Returns number

sweepGuildMembers

• sweepGuildMembers(filter: CollectionSweepFilter<string, GuildMember>): number

  Parameters

  • filter: CollectionSweepFilter<string, GuildMember>

  Returns number

sweepInvites

• sweepInvites(filter: CollectionSweepFilter<string, Invite>): number

  Parameters

  • filter: CollectionSweepFilter<string, Invite>

  Returns number

sweepMessages

• sweepMessages(filter: CollectionSweepFilter<string, Message<boolean>>): number

  Parameters

  • filter: CollectionSweepFilter<string, Message<boolean>>

  Returns number

sweepPresences

• sweepPresences(filter: CollectionSweepFilter<string, Presence>): number

  Parameters

  • filter: CollectionSweepFilter<string, Presence>

  Returns number

sweepReactions

• sweepReactions(filter: CollectionSweepFilter<string, MessageReaction>): number

  Parameters

  • filter: CollectionSweepFilter<string, MessageReaction>

  Returns number

sweepStageInstances

• sweepStageInstances(
      filter: CollectionSweepFilter<string, StageInstance>,
  ): number

  Parameters

  • filter: CollectionSweepFilter<string, StageInstance>

  Returns number

sweepStickers

• sweepStickers(filter: CollectionSweepFilter<string, Sticker>): number

  Parameters

  • filter: CollectionSweepFilter<string, Sticker>

  Returns number

sweepThreadMembers

• sweepThreadMembers(
      filter: CollectionSweepFilter<string, ThreadMember<boolean>>,
  ): number

  Parameters

  • filter: CollectionSweepFilter<string, ThreadMember<boolean>>

  Returns number

sweepThreads

• sweepThreads(filter: CollectionSweepFilter<string, AnyThreadChannel>): number

  Parameters

  • filter: CollectionSweepFilter<string, AnyThreadChannel>

  Returns number

sweepUsers

• sweepUsers(filter: CollectionSweepFilter<string, User>): number

  Parameters

  • filter: CollectionSweepFilter<string, User>

  Returns number

sweepVoiceStates

• sweepVoiceStates(filter: CollectionSweepFilter<string, VoiceState>): number

  Parameters

  • filter: CollectionSweepFilter<string, VoiceState>

  Returns number

StaticarchivedThreadSweepFilter

• archivedThreadSweepFilter(
      lifetime?: number,
  ): GlobalSweepFilter<string, AnyThreadChannel>

  Parameters

  • Optionallifetime: number

  Returns GlobalSweepFilter<string, AnyThreadChannel>

StaticexpiredInviteSweepFilter

• expiredInviteSweepFilter(lifetime?: number): GlobalSweepFilter<string, Invite>

  Parameters

  • Optionallifetime: number

  Returns GlobalSweepFilter<string, Invite>

StaticfilterByLifetime

• filterByLifetime<Key, Value>(
      options?: LifetimeFilterOptions<Key, Value>,
  ): GlobalSweepFilter<Key, Value>

  Type Parameters

  • Key
  • Value

  Parameters

  • Optionaloptions: LifetimeFilterOptions<Key, Value>

  Returns GlobalSweepFilter<Key, Value>

StaticoutdatedMessageSweepFilter

• outdatedMessageSweepFilter(
      lifetime?: number,
  ): GlobalSweepFilter<string, Message<boolean>>

  Parameters

  • Optionallifetime: number

  Returns GlobalSweepFilter<string, Message<boolean>>