FEWS Web OC

@deltares/fews-web-oc-composables

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

Interface: UsePiTimeSeriesOptions ​

Defined in: usePiTimeSeries/index.ts:78

Properties ​

enabled? ​

optional enabled?: Ref<boolean, boolean>

Defined in: usePiTimeSeries/index.ts:95

Controls whether time series may be fetched.

Default ​

ts
ref(true)

query? ​

optional query?: MaybeRefOrGetter<PiTimeSeriesQueryOptions | undefined>

Defined in: usePiTimeSeries/index.ts:88

Query options applied to every request.

refresh? ​

optional refresh?: object

Defined in: usePiTimeSeries/index.ts:107

Configuration for automatic time series 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
30000 (30 seconds)

policies? ​

optional policies?: RefreshPolicy[]

Policies that trigger an automatic refresh.

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

systemTick? ​

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

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

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

requests ​

requests: MaybeRefOrGetter<PiTimeSeriesRequest[] | undefined>

Defined in: usePiTimeSeries/index.ts:83

The time series requests, identified by a unique key. When undefined or empty, in-flight requests are cancelled and no new requests are made.

webservice? ​

optional webservice?: PiWebserviceOptions

Defined in: usePiTimeSeries/index.ts:102

Optional webservice configuration for standalone usage.

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