R
fn

useAsyncState

testeddemo

A composable that provides a state for async operations without setup blocking

Demo

Loading demo…

Signature

ts
export function useAsyncState<Data, Params extends any[] = [], Shallow extends boolean = true>(
  maybePromise: Promise<Data> | ((...args: Params) => Promise<Data>),
  initialState: Data,
  options?: UseAsyncStateOptions<Shallow, Data>,
): UseAsyncStateReturn<Data, Params, Shallow>{ ... }

Type Parameters

Data
Paramsextends any[]= []
Shallowextends boolean= true

Parameters

ParameterTypeDescription
maybePromisePromise<Data> | ((...args: Params) => Promise<Data>)
initialStateData
options?UseAsyncStateOptions<Shallow, Data> | undefined

Returns

UseAsyncStateReturn<Data, Params, Shallow>