Interface PurgeOptions<T>

Type Parameters

T extends AnyTextableGuildChannel | Uncached

Hierarchy

PurgeOptions

Index

Methods

Properties

after? around? before? limit reason?

Methods

`Optional` filter

filter(message): boolean | "break" | PromiseLike<boolean | "break">
A function used to reject certain messages. If "break" is returned, further iteration of messages will stop and purging will begin immediately.
Parameters
- message: Message<T>
  
  The message to filter.
Returns boolean | "break" | PromiseLike<boolean | "break">
- Defined in lib/types/channels.d.ts:1056

Properties

`Optional` after

after?: string

The ID of the message to purge after.

`Optional` around

around?: string

The ID of the message to purge around.

`Optional` before

before?: string

The ID of the message to purge before.

limit

limit: number

The limit of messages to purge.

`Optional` reason

reason?: string

The reason for purging the messages.