Function useQueryStateValuesOnMount

useQueryStateValuesOnMount<T extends Record<any, any>>(
    typeFilterObject: TypeFilterObject<T>,
    defaultValues: TypeOrFunction<T>,
    keyPrefix?: UseQueryStateValuesOnMountOptions,
): T
Returns an object containing values from the query state at mount time. Any values not present in the query state are populated by the given default values.

Designed not to update from updates to the query state. For a live-updating version, see useQueryStateSync.

The identities of all arguments do not need to be stable and changes will not cause changes to the values returned.
Type Parameters
- T extends Record<any, any>
Parameters
- typeFilterObject: TypeFilterObject<T>
  A type filter object for the type T.
- defaultValues: TypeOrFunction<T>
  An object containing default values for each key or a function returning such an object. Only used if a key is not present in the query state.
- keyPrefix: UseQueryStateValuesOnMountOptions = {}
  Prefix for the keys in the query string.
Returns T