Interface PurgeOptions<T>

interface PurgeOptions<T> {
    after?: string;
    around?: string;
    before?: string;
    limit: number;
    reason?: string;
    filter?(message): boolean | "break" | PromiseLike<boolean | "break">;
}

Type Parameters

Properties

after? around? before? limit reason?

Methods

filter?

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. 0 will return immediately, use Infinity for no limit.

Optional reason

reason?: string

The reason for purging the messages.

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">

Settings

Member Visibility

Theme

On This Page

afteraroundbeforelimitreasonfilter