Paginator

A restart-proof paginator. Each nav button's customId encodes its full target page, so clicks are idempotent and survive a restart. A persistent @ButtonRoute on Handler dispatches the clicks.

class Paginator<Item, Prefix extends string> extends PaginatorBase<
    Item,
    Prefix,
    PageContext
>

export const Bans = new Paginator({
    prefix: 'bans',
    source: new ArraySource((ctx) => ctx.guild.bans.fetch().then((b) => [...b.values()]), { perPage: 10 }),
    renderItem: (ban) => ban.user.tag
});

\@ButtonRoute(Bans.cursor)
export class BansNav extends Bans.Handler {}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Paginator class

Paginator(config: PaginatorConfig<Item, Prefix, PageContext>)

Showing members with Protected visibility and higher.

Methods

page()
start()

Item

The item type, inferred from the source.

Item

Prefix

The route prefix, inferred from config.prefix.

Prefix extends string

config

protected readonly config: PaginatorConfig<Item, Prefix, Ctx>

Inherited from:PaginatorBase

cursor

The page cursor, pass it to your @ButtonRoute.

readonly cursor: PageCursor<Prefix>

Inherited from:PaginatorBase

Handler

The nav handler base. Extend it with an empty body and decorate it, @ButtonRoute(p.cursor).

public readonly Handler: PaginatorHandlerCtor<Prefix>

page()

Render a page as a ReplyResponse. To post it elsewhere, add flags: MessageFlags.IsComponentsV2.

async page(
    ctx: Ctx,
    n: number
): Promise<ReplyResponse>

Inherited from:PaginatorBase

start()

Render page 0 and send it through the handler's sender, which picks reply, edit, or followUp from its ack state.

public async start(
    handler: RepliableHandler<Repliables>
): Promise<Message>

Parameter: handler

The handler starting the paginator, normally this.