Interface BanOptions

Extra options regarding bans.

interface BanOptions {
    duration?: number;
    message?: string;
    note?: string;
    reason?: string;
}

Properties

duration?: number

How long to ban the user for, in days. Omit this for a permanent ban.

message?: string

The ban message. This will be sent to the user.

note?: string

A note to the other moderators about why this user was banned (max 300 characters).

reason?: string

The reason for the ban (max 100 characters).