Interface GetChannelPinsOptions<T>

interface GetChannelPinsOptions<T> {
    before?: string;
    limit?: number;
    filter?(pin): boolean | "break" | PromiseLike<boolean | "break">;
}

Type Parameters

T extends AnyTextableChannel | Uncached = AnyTextableChannel | Uncached

Index

Properties

Methods

Properties

`Optional` before

before?: string

Get messages pinned before this ISO8601 timestamp.

`Optional` limit

limit?: number

The maximum amount of pins to get. Defaults to 50. Use Infinity if you wish to get as many pins as possible.

Methods

`Optional` filter

filter(pin): boolean | "break" | PromiseLike<boolean | "break">
A function used to reject certain pins. If "break" is returned, further iteration of pins will stop and the previously allowed pins will be returned.
Parameters
- pin: MessagePin<T>
  The pin to filter.
Returns boolean | "break" | PromiseLike<boolean | "break">
- Defined in lib/types/channels.d.ts:865