@deltares/fews-web-oc-composables

---

@deltares/fews-web-oc-composables / RefreshCoordinator

Interface: RefreshCoordinator

Defined in: useRefreshCoordinator/index.ts:54

Properties

isActive

isActive: Readonly<Ref<boolean>>

Defined in: useRefreshCoordinator/index.ts:58

Whether automatic refreshes are currently active.

---

lastRefreshAt

lastRefreshAt: Readonly<Ref<Date | undefined>>

Defined in: useRefreshCoordinator/index.ts:80

The time at which the most recent refresh completed successfully.

---

lastTriggerPolicy

lastTriggerPolicy: Readonly<Ref<RefreshPolicy | undefined>>

Defined in: useRefreshCoordinator/index.ts:85

The policy that caused the most recent refresh.

---

pause

pause: () => void

Defined in: useRefreshCoordinator/index.ts:63

Pauses automatic refreshes.

Returns

void

---

resume

resume: () => void

Defined in: useRefreshCoordinator/index.ts:68

Resumes automatic refreshes.

Returns

void

---

trigger

trigger: (policy?) => void

Defined in: useRefreshCoordinator/index.ts:75

Requests a refresh.

The refresh is ignored when the coordinator is paused or disabled.

Parameters

policy?

RefreshPolicy

Returns

void