realue • Docs
realue / useAsyncProps
useAsyncProps<
T,Q>(options,dependencies?):Select<AsyncPropsResult<T|undefined>,"onChange",never>
Asynchronously handles getting the value and its onChanges by handleing queries and subscribing to updates.
If options.value(name) is set, uses the defined return value (a "query") and passes it to options.handle(query). If options.value(name) returns an undefined value, nothing happens.
If options.onChange(value, name) is set, uses the defined return value (a "query") and passes it to options.handle(query). If options.onChange(value, name) returns an undefined value, nothing happens.
The options.handle(query) function returns asynchronously (or, if needed, synchronously) a value that gets returned in the result.
Asynchronous tasks can be tracked with the returned status property, and aborted using the returned onAbort() method. Ongoing operations are automatically aborted when the element that runs this hook unmounts.
The asynchronous task that gets the value can be re-executed using the returned onRefresh() method.
If options.subscribe(query, onRefresh) is defined, it is called everytime a new query is returned by options.value(name), and passed along with the onRefresh(query) method to trigger a refresh. The onRefresh(query) is called with a change query to ignore the queries that emanate from the element using this hook. The options.subscribe(query, onRefresh) function can return a function that gets called before a new options.subcribe(query, onRefresh) call is made or when the element unmounts, enabling unsubscription logic to happen.
• T
• Q
• options: Select<AsyncPropsOptions<T, Q>, "onChange", "props">
Contains the optional value and onChange query builders, the required handle(query) method, the optional subscribe(query, onRefresh) method, and the optional parent props according to the NEVO pattern (with support for status and onChangeStatus).
• dependencies?: Inputs
List of values that, when changing, trigger a new asynchronous value loading task, if options.value(name) is set, refresh the subscription, if options.subscribe(query, onRefresh) is set, and updates the definition of the returned onChange function.
Select<AsyncPropsResult<T | undefined>, "onChange", never>
The properties according to the NEVO pattern, with the status of the ongoing task, and the onRefresh() and onAbort() methods.
useAsyncProps<
T,Q>(options,dependencies?):Select<AsyncPropsResult<T|undefined>,never,"onChange">
• T
• Q
• options: never
• dependencies?: Inputs
Select<AsyncPropsResult<T | undefined>, never, "onChange">
useAsyncProps<
T,Q>(options,dependencies?):Select<AsyncPropsResult<T|undefined>,never,"onChange">
• T
• Q
• options: Select<AsyncPropsOptions<T, Q>, never, "onChange" | "props">
• dependencies?: Inputs
Select<AsyncPropsResult<T | undefined>, never, "onChange">
useAsyncProps<
T,Q>(options,dependencies?):Select<AsyncPropsResult<T>,"onChange",never>
• T
• Q
• options: never
• dependencies?: Inputs
Select<AsyncPropsResult<T>, "onChange", never>
useAsyncProps<
T,Q>(options,dependencies?):Select<AsyncPropsResult<T>,"onChange",never>
• T
• Q
• options: Select<AsyncPropsOptions<T, Q>, "onChange" | "props", never>
• dependencies?: Inputs
Select<AsyncPropsResult<T>, "onChange", never>
useAsyncProps<
T,Q>(options,dependencies?):AsyncPropsResult<T>
• T
• Q
• options: Select<AsyncPropsOptions<T, Q>, "props", "onChange">
• dependencies?: Inputs
AsyncPropsResult<T>