Interface GetChannelPinsIteratorOptions<T>

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

Type Parameters

Properties

before? limit?

Methods

filter?

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, the iterator will immediately exit and yield the previously allowed pins.

    Parameters

    Returns boolean | "break" | PromiseLike<boolean | "break">

Settings

Member Visibility

Theme

On This Page

beforelimitfilter