FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UseWmsRefreshOptions ​

Defined in: useWms/options.ts:7

Properties ​

immediate? ​

optional immediate?: boolean

Defined in: useWms/options.ts:32

Whether to fetch immediately when the composable is created.

Default ​

ts
true

intervalMs? ​

optional intervalMs?: number

Defined in: useWms/options.ts:19

Interval between automatic refreshes when 'onInterval' is enabled.

Default ​

ts
300000 (5 minutes)

policies? ​

optional policies?: RefreshPolicy[]

Defined in: useWms/options.ts:12

Policies that trigger a scheduled automatic refresh. The default varies by composable.

systemTick? ​

optional systemTick?: Ref<Date | undefined, Date | undefined>

Defined in: useWms/options.ts:25

The system-time synchronization signal used by the onSystemTick refresh policy. When omitted, the host-provided system tick is used.