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

Interface PaginateArgs<RT, E>

Defined in: warp-drive-packages/core/src/signals/pagination-subscription.ts:80

Extends

• PaginationSubscriptionArgs<RT, E>

Type Parameters

RT

RT

E

E

Properties

autorefresh?

optional autorefresh?: AutorefreshBehaviorCombos;

Defined in: warp-drive-packages/core/src/signals/request-subscription.ts:149

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

PaginationSubscriptionArgs.autorefresh

---

autorefreshBehavior?

optional autorefreshBehavior?: "reload" | "refresh" | "policy";

Defined in: warp-drive-packages/core/src/signals/request-subscription.ts:175

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

PaginationSubscriptionArgs.autorefreshBehavior

---

autorefreshThreshold?

optional autorefreshThreshold?: number;

Defined in: warp-drive-packages/core/src/signals/request-subscription.ts:161

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

PaginationSubscriptionArgs.autorefreshThreshold

---

mode?

optional mode?: PaginateMode;

Defined in: warp-drive-packages/core/src/signals/pagination-subscription.ts:86

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?

optional pageHints?: PageHints;

Defined in: warp-drive-packages/core/src/signals/pagination-subscription.ts:77

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 <Paginate /> components sharing a collection.

Inherited from

PaginationSubscriptionArgs.pageHints

---

query?

optional query?: 
  | StoreRequestInput<RT>
  | null;

Defined in: warp-drive-packages/core/src/signals/request-subscription.ts:134

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

PaginationSubscriptionArgs.query

---

request?

optional request?: Future<RT> | null;

Defined in: warp-drive-packages/core/src/signals/request-subscription.ts:126

The request to monitor. This should be a Future instance returned by either the store.request or store.requestManager.request methods.

Inherited from

PaginationSubscriptionArgs.request

---

store?

optional store?: 
  | Store
  | RequestManager;

Defined in: warp-drive-packages/core/src/signals/pagination-subscription.ts:98

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?

optional subscription?: PaginationSubscription<RT, E>;

Defined in: warp-drive-packages/core/src/signals/pagination-subscription.ts:88