Interfacecorev0.10.0

PaginatorConfig

The transport-agnostic paginator configuration. Each transport adds its own handler wiring on top.

interface PaginatorConfig<Item, Prefix extends string, Ctx>

Properties

The item type, inferred from the source.

Item

The route prefix, inferred from prefix.

Prefix extends string

The transport's page context.

Ctx

Whether the first page is ephemeral.

ephemeral?: boolean

Default:false

The route prefix used to build the page cursor on the nav buttons.

prefix: Prefix;

Take over the whole page tree. Receives the page data and the controls factory.

render?: PageRender<Item>

Render one item, index is its absolute position across pages. Ignored when render is set.

renderItem?: ItemRender<Item>

source: PageSourceBase<Item, Ctx>;