Classseedcordv0.15.0

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@ButtonRoute on HandlerHandler dispatches the clicks.

class Paginator<Item, Prefix extends string>

class Paginator<Item, Prefix extends string>

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 {}

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 PaginatorPaginator class

Paginator(config: PaginatorConfig<Item, Prefix>)

Paginator(config: PaginatorConfig<Item, Prefix>)

Showing members with Protected visibility and higher.

Methods

page()
start()

Item

The item type, inferred from the source.

Item

Item

Prefix

The route prefix, inferred from config.prefixconfig.prefix.

Prefix extends string

Prefix extends string

cursor

The page cursor, pass it to your @ButtonRoute@ButtonRoute.

public readonly cursor: PageCursor<Prefix>

public readonly cursor: PageCursor<Prefix>

Handler

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

public readonly Handler: PaginatorHandlerCtor<Prefix>

public readonly Handler: PaginatorHandlerCtor<Prefix>

page()

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

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

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

start()

Render page 0 and send it, picking reply or followUp from the interaction's state.

public async start(
    interaction: Repliables,
    core?: Core
): Promise<Message | undefined>

public async start(
    interaction: Repliables,
    core?: Core
): Promise<Message | undefined>