Documentation / @warp-drive/core / reactive / RequestSubscription

Interface: RequestSubscription<RT, E>

Defined in: core/src/signals/request-subscription.ts:138

Hideconstructor

A reactive class

Type Parameters

RT

RT

E

E

Methods

(symbol) dispose()

(symbol) dispose(): void;

Defined in: core/src/signals/request-subscription.ts:143

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

Returns

void

---

refresh()

refresh(): Promise<void>;

Defined in: core/src/signals/request-subscription.ts:635

Refresh the request, updating it in the background.

Returns

Promise<void>

---

retry()

retry(): Promise<void>;

Defined in: core/src/signals/request-subscription.ts:627

Retry the request, reloading it from the server.

Returns

Promise<void>

Properties

isHidden

isHidden: boolean;

Defined in: core/src/signals/request-subscription.ts:160

Whether the browser reports that the tab is hidden.

---

isOnline

isOnline: boolean;

Defined in: core/src/signals/request-subscription.ts:155

Whether the browser reports that the network is online.

---

isRefreshing

isRefreshing: boolean;

Defined in: core/src/signals/request-subscription.ts:165

Whether the component is currently refreshing the request.

---

store

store: 
  | Store
  | RequestManager;

Defined in: core/src/signals/request-subscription.ts:247

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

autorefreshTypes

Get Signature

get autorefreshTypes(): Set<AutorefreshBehaviorType>;

Defined in: core/src/signals/request-subscription.ts:301

Returns

Set<AutorefreshBehaviorType>

---

contentFeatures

Get Signature

get contentFeatures(): ContentFeatures<RT>;

Defined in: core/src/signals/request-subscription.ts:656

features to yield to the content slot of a component

Returns

ContentFeatures<RT>

---

errorFeatures

Get Signature

get errorFeatures(): RecoveryFeatures;

Defined in: core/src/signals/request-subscription.ts:644

features to yield to the error slot of a component

Returns

RecoveryFeatures

---

isIdle

Get Signature

get isIdle(): boolean;

Defined in: core/src/signals/request-subscription.ts:294

Returns

boolean

---

reqState

Get Signature

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

Defined in: core/src/signals/request-subscription.ts:719

Returns

RequestState<RT, StructuredErrorDocument<E>>

---

request

Get Signature

get request(): Future<RT>;

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

Returns

Future<RT>

---

result

Get Signature

get result(): RT;

Defined in: core/src/signals/request-subscription.ts:723

Returns

RT