Skip to content

Compositions: useQueryValue()

ts
const useQueryValue: {
  (key): UseQueryValue<string>;
<TParam>  (key, param): UseQueryValue<ExtractParamType<TParam>>;
};

A composition to access a specific query value from the current route.

Call Signature

ts
(key): UseQueryValue<string>;

Parameters

ParameterType
keyMaybeRefOrGetter<string>

Returns

UseQueryValue<string>

Call Signature

ts
<TParam>(key, param): UseQueryValue<ExtractParamType<TParam>>;

Type Parameters

Type Parameter
TParam extends Param

Parameters

ParameterType
keyMaybeRefOrGetter<string>
paramTParam

Returns

UseQueryValue<ExtractParamType<TParam>>

Returns

The query value from the router.