module@warp-drive/core/reactive

Interface RequestSubscription<RT, E>

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

Hideconstructor

A reactive class

Type Parameters

RT

RT

E

E

Methods

(symbol) dispose()

(symbol) dispose(): void;

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

The method to call when the component this subscription is attached to unmounts.

Returns

void

---

refresh()

refresh(): Promise<void>;

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

Refresh the request, updating it in the background.

Returns

Promise<void>

---

retry()

retry(): Promise<void>;

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

Retry the request, reloading it from the server.

Returns

Promise<void>

Properties

isHidden

isHidden: boolean;

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

Whether the browser reports that the tab is hidden.

---

isOnline

isOnline: boolean;

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

Whether the browser reports that the network is online.

---

isRefreshing

isRefreshing: boolean;

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

Whether the component is currently refreshing the request.

---

store

store: 
  | Store
  | RequestManager;

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

The Store this subscription subscribes to or the RequestManager which issues this request.

autorefreshTypes

Get Signature

get autorefreshTypes(): Set<AutorefreshBehaviorType>;

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

The set of AutorefreshBehaviorTypes this subscription is configured to autorefresh for, derived from SubscriptionArgs.autorefresh.

Returns

Set<AutorefreshBehaviorType>

---

contentFeatures

Get Signature

get contentFeatures(): ContentFeatures<RT>;

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

features to yield to the content slot of a component

Returns

ContentFeatures<RT>

---

errorFeatures

Get Signature

get errorFeatures(): RecoveryFeatures;

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

features to yield to the error slot of a component

Returns

RecoveryFeatures

---

isIdle

Get Signature

get isIdle(): boolean;

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

Whether neither a request nor a query arg was provided, and so this subscription has nothing to fetch or monitor.

Returns

boolean

---

reqState

Get Signature

get reqState(): RequestState<RT, StructuredErrorDocument<E>>;

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

The RequestState for request.

Returns

RequestState<RT, StructuredErrorDocument<E>>

---

request

Get Signature

get request(): Future<RT>;

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

The Future this subscription is currently monitoring, and (re-)subscribes to notifications for as a side effect of access.

Returns

Future<RT>

---

result

Get Signature

get result(): RT;

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

The resolved content of the request, once it has succeeded.

Returns

RT