module@warp-drive/core/signals/-leaked

Interface PageHints() sincev5.9.0

Defined in: warp-drive-packages/core/src/signals/pagination-cache.ts:29

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): object;

Defined in: warp-drive-packages/core/src/signals/pagination-cache.ts:30

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

object

currentPage

currentPage: number;

totalPages

totalPages: number;