Interface PurgeOptions<T>

Type Parameters

T extends AnyGuildTextChannel | Uncached

Hierarchy

PurgeOptions

Index

Properties

after? around? before? limit reason?

Methods

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.

Methods

`Optional` filter

filter(message: Message<T>): boolean | PromiseLike<boolean>
The filter to apply to messages to decide if they should be purged.
Parameters
- message: Message<T>
  
  The message to filter.
Returns boolean | PromiseLike<boolean>
- Defined in lib/types/channels.d.ts:960