FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UseRefreshCoordinatorOptions ​

Defined in: useRefreshCoordinator/index.ts:8

Properties ​

enabled? ​

optional enabled?: Ref<boolean, boolean>

Defined in: useRefreshCoordinator/index.ts:51

A reactive flag controlling whether automatic refreshes are currently enabled. When false, all triggers are ignored until it becomes true again.

Default ​

ts
ref(true)

immediateCallback? ​

optional immediateCallback?: boolean

Defined in: useRefreshCoordinator/index.ts:42

Whether to invoke the callback immediately when the coordinator is created.

Default ​

ts
false

intervalMs? ​

optional intervalMs?: number

Defined in: useRefreshCoordinator/index.ts:34

The interval, in milliseconds, between automatic refreshes when 'onInterval' is included in policies.

Default ​

ts
1000

policies ​

policies: RefreshPolicy[]

Defined in: useRefreshCoordinator/index.ts:14

The policies that can trigger a refresh. Only policies included here have any effect; e.g. 'onInterval' must be included for intervalMs to take effect.

systemTick? ​

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

Defined in: useRefreshCoordinator/index.ts:26

The system-time synchronization tick, used by the 'onSystemTick' policy. A refresh is triggered whenever this ref's value changes.

Default ​

When omitted, the host-provided system tick (from useHostRefreshContext()) is used. This allows standalone applications to provide their own system tick without requiring microfrontend developers to configure anything.