--- url: /api/@warp-drive/experiments/pagination/types/PaginateArgs.md --- # PaginateArgs\ ```ts interface PaginateArgs extends PaginationSubscriptionArgs { autorefresh?: AutorefreshBehaviorCombos; autorefreshBehavior?: "reload" | "refresh" | "policy"; autorefreshThreshold?: number; mode?: PaginateMode; pageHints?: PageHints; query?: StoreRequestInput | null; request?: Future | null; store?: Store$1 | RequestManager; subscription?: PaginationSubscription; } ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/signals/-leaked.d.ts:808](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts#L808) ## Extends * `PaginationSubscriptionArgs`<`RT`, `E`> ## Type Parameters ### RT `RT` ### E `E` ## Properties ### autorefresh? ```ts optional autorefresh?: AutorefreshBehaviorCombos; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts:9037](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts#L9037) The autorefresh behavior for the request. This can be a boolean, or any combination of the following values: `'online'`, `'interval'`, `'invalid'`. * `'online'`: Refresh the request when the browser comes back online * `'interval'`: Refresh the request at a specified interval * `'invalid'`: Refresh the request when the store emits an invalidation If `true`, this is equivalent to `'online,invalid'`. Defaults to `false`. #### Inherited from ```ts PaginationSubscriptionArgs.autorefresh ``` *** ### autorefreshBehavior? ```ts optional autorefreshBehavior?: "reload" | "refresh" | "policy"; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts:9061](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts#L9061) The behavior of the request initiated by autorefresh. This can be one of the following values: * `'refresh'`: Refresh the request in the background * `'reload'`: Force a reload of the request * `'policy'` (**default**): Let the store's configured CachePolicy decide whether to reload, refresh, or do nothing. Defaults to `'policy'`. #### Inherited from ```ts PaginationSubscriptionArgs.autorefreshBehavior ``` *** ### autorefreshThreshold? ```ts optional autorefreshThreshold?: number; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts:9048](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts#L9048) The number of milliseconds to wait before refreshing the request when the browser comes back online or the network becomes available. This also controls the interval at which the request will be refreshed if the `interval` autorefresh type is enabled. Defaults to `30_000` (30 seconds). #### Inherited from ```ts PaginationSubscriptionArgs.autorefreshThreshold ``` *** ### mode? ```ts optional mode?: PaginateMode; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/signals/-leaked.d.ts:814](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts#L814) Which navigation surface the component yields: `'paged'` (the default) or `'infinite'`. Type-only — it narrows the yielded state and features so the two surfaces cannot be mixed, and is never read at runtime. *** ### pageHints? ```ts optional pageHints?: PageHints; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/signals/-leaked.d.ts:806](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts#L806) A function to extract the `currentPage` and `totalPages` from a loaded document when they are not available in the default `meta` locations. Must be the same reference across all `` components sharing a collection. #### Inherited from ```ts PaginationSubscriptionArgs.pageHints ``` *** ### query? ```ts optional query?: StoreRequestInput | null; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts:9023](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts#L9023) A query to use for the request. This should be an object that can be passed to `store.request`. Use this in place of `@request` if you would like the component to also initiate the request. #### Inherited from ```ts PaginationSubscriptionArgs.query ``` *** ### request? ```ts optional request?: Future | null; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts:9016](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/internal-BMLTHcGO.d.ts#L9016) The request to monitor. This should be a `Future` instance returned by either the `store.request` or `store.requestManager.request` methods. #### Inherited from ```ts PaginationSubscriptionArgs.request ``` *** ### store? ```ts optional store?: Store$1 | RequestManager; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/signals/-leaked.d.ts:824](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts#L824) The store instance to use for making requests. If contexts are available, the component will default to using the `store` on the context. This is required if the store is not available via context or should be different from the store provided via context. *** ### subscription? ```ts optional subscription?: PaginationSubscription; ``` Defined in: [node\_modules/.pnpm/@warp-d\_5e1563e0e582c8365bb74466d3761d6d/node\_modules/@warp-drive/core/dist/signals/-leaked.d.ts:815](https://github.com/warp-drive-data/warp-drive/blob/9139b32616fa566f39a5ed15355c0daea087b8ed/node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts#L815)