FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UsePiLocationsOptions ​

Defined in: usePiLocations/index.ts:38

Properties ​

enabled? ​

optional enabled?: Ref<boolean, boolean>

Defined in: usePiLocations/index.ts:56

Controls whether locations may be fetched automatically.

When false, refresh-coordinator triggers are ignored.

Default ​

ts
ref(true)

filter ​

filter: Ref<LocationsFilter | undefined>

Defined in: usePiLocations/index.ts:47

Reactive filter used when fetching locations. When undefined, no request is made and the result is empty.

The current value is read when fetch() is executed. Meaningful parameter changes clear the current result and fetch locations for the new filter automatically. Equivalent replacements are ignored.

refresh? ​

optional refresh?: object

Defined in: usePiLocations/index.ts:68

Configuration for automatic location refreshing.

immediate? ​

optional immediate?: boolean

Whether to fetch immediately when the composable is created.

Default ​
ts
true

intervalMs? ​

optional intervalMs?: number

Interval between automatic refreshes when 'onInterval' is enabled.

Default ​
ts
300000 (5 minutes)

policies? ​

optional policies?: RefreshPolicy[]

Policies that trigger an automatic refresh.

Default ​
ts
['onSystemTick', 'onInterval', 'onVisibilityResume']

systemTick? ​

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

The system-time synchronization signal used by the onSystemTick refresh policy.

Standalone applications can provide their own system tick.

Default ​
ts
When omitted, the host-provided system tick is used.

webservice? ​

optional webservice?: PiWebserviceOptions

Defined in: usePiLocations/index.ts:63

Optional webservice configuration for standalone usage.

When omitted, the host-provided webservice context is used.