Documentation / @warp-drive/core / signals/-leaked / SubscriptionArgs
Interface: SubscriptionArgs<RT, E>
Defined in: core/src/signals/request-subscription.ts:67
Extended by
Type Parameters
RT
RT
E
E
Properties
autorefresh?
optional autorefresh: AutorefreshBehaviorCombos;Defined in: core/src/signals/request-subscription.ts:96
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.
autorefreshBehavior?
optional autorefreshBehavior: "reload" | "refresh" | "policy";Defined in: core/src/signals/request-subscription.ts:122
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'.
autorefreshThreshold?
optional autorefreshThreshold: number;Defined in: core/src/signals/request-subscription.ts:108
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).
query?
optional query:
| null
| StoreRequestInput<RT>;Defined in: core/src/signals/request-subscription.ts:81
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.
request?
optional request: null | Future<RT>;Defined in: core/src/signals/request-subscription.ts:73
The request to monitor. This should be a Future instance returned by either the store.request or store.requestManager.request methods.