module@warp-drive/experiments/pagination @experimental

Function createPaginationSubscription() sincev5.9.0

function createPaginationSubscription<RT, E>(store: Store$1 | RequestManager, args: PaginationSubscriptionArgs<RT, E>): PaginationSubscription<RT, E>;

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

Creates the PaginationSubscription a <Paginate /> component uses to manage its request lifecycle and pagination state. Pass the result back into the component via @subscription to manage the lifecycle externally.

const subscription = createPaginationSubscription(store, { request });

subscription.paginationState; // the per-component PaginationState
subscription[DISPOSE](); // tear down when the owning component unmounts

Type Parameters

RT

RT

E

E

Parameters

store

Store$1 | RequestManager

args

PaginationSubscriptionArgs<RT, E>

Returns

PaginationSubscription<RT, E>