@deltares/fews-web-oc-composables

---

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

Interface: UseWmsRequestReturn

Defined in: useWms/options.ts:53

Extended by

• UseWmsLegendReturn
• UseWmsCapabilitiesReturn
• UseWmsReturn

Properties

cancel

cancel: () => void

Defined in: useWms/options.ts:76

Cancels the currently running request, if any.

Returns

void

---

error

error: Readonly<Ref<Error | null>>

Defined in: useWms/options.ts:61

Error from the most recent request, or null when there is no error.

---

fetch

fetch: () => Promise<void>

Defined in: useWms/options.ts:73

Fetches the requested WMS data immediately.

Returns

Promise<void>

---

hasAttempted

hasAttempted: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:70

Whether a request has completed for the current inputs, successfully or not.

---

hasLoaded

hasLoaded: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:64

Whether a successful response is available for the current inputs.

---

lastRefreshAt

lastRefreshAt: Readonly<Ref<Date | undefined>>

Defined in: useWms/options.ts:88

Time at which the most recent refresh completed successfully.

---

lastTriggerPolicy

lastTriggerPolicy: Readonly<Ref<RefreshPolicy | undefined>>

Defined in: useWms/options.ts:91

Policy that caused the most recent refresh.

---

loading

loading: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:55

Whether the initial request is in progress.

---

pauseRefresh

pauseRefresh: () => void

Defined in: useWms/options.ts:82

Pauses automatic refreshes.

Returns

void

---

refreshing

refreshing: Readonly<Ref<boolean>>

Defined in: useWms/options.ts:58

Whether a subsequent request is in progress.

---

requestRefresh

requestRefresh: () => void

Defined in: useWms/options.ts:79

Requests a refresh through the refresh coordinator.

Returns

void

---

resumeRefresh

resumeRefresh: () => void

Defined in: useWms/options.ts:85

Resumes automatic refreshes.

Returns

void