module@warp-drive/experiments/pagination @experimental

Interface PageHints() sincev5.9.0

interface PageHints {}

Defined in: node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts:121

A hint function for extracting the currentPage and totalPages from a loaded document, for when the response does not expose these values through the default meta locations. Provided by the consumer via <Paginate />'s @pageHints arg:

<Paginate @pageHints={{...}} />

Since these values are attached to the shared PaginationCache, the hint is a property of the collection, not the component. Every <Paginate /> sharing a collection must provide the same function reference — define it once at module scope and import it everywhere.

PageHints(document: ReactiveDocument<unknown>): {
  currentPage: number;
  totalPages: number;
};

Defined in: node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts:122

A hint function for extracting the currentPage and totalPages from a loaded document, for when the response does not expose these values through the default meta locations. Provided by the consumer via <Paginate />'s @pageHints arg:

<Paginate @pageHints={{...}} />

Since these values are attached to the shared PaginationCache, the hint is a property of the collection, not the component. Every <Paginate /> sharing a collection must provide the same function reference — define it once at module scope and import it everywhere.

Parameters

document

ReactiveDocument<unknown>

Returns

{
  currentPage: number;
  totalPages: number;
}

currentPage

currentPage: number;

totalPages

totalPages: number;