Function useQueryState

packages/nuqs/src/useQueryState.ts:194–229

(
  key: string,
  options: Partial<UseQueryStateOptions<T>> & {
    defaultValue?: T
  } = {}
)

 * @param options - Parser (defines the state data type), optional default value and history mode.
 */
export function useQueryState<T = string>(
  key: string,
  options: Partial<UseQueryStateOptions<T>> & {
    defaultValue?: T
  } = {}
) {
  const { parse, type, serialize, eq, defaultValue, ...hookOptions } = options
  const [{ [key]: state }, setState] = useQueryStates(
    {
      [key]: {
        parse: parse ?? ((x: any) => x as unknown as T),
        type,
        serialize,
        eq,
        defaultValue
      } as GenericParser<T>
    },
    hookOptions
  )
  const update = useCallback(
    (stateUpdater: React.SetStateAction<T | null>, callOptions: Options = {}) =>
      setState(
        old => ({
          [key]:
            typeof stateUpdater === 'function'
              ? // @ts-expect-error somehow stateUpdater is not narrowed correctly
                // and useQueryStates' key type is not inferred
                stateUpdater(old[key])
              : stateUpdater
        }),
        callOptions
      ),
    [key, setState]
  )
  return [state, update]
}