drone/web/src/hooks/useQueryParams.ts
2022-08-26 15:57:05 -07:00

26 lines
727 B
TypeScript

import React from 'react'
import { useLocation } from 'react-router-dom'
import qs from 'qs'
import type { IParseOptions } from 'qs'
import type { Unknown } from 'utils/Utils'
export interface UseQueryParamsOptions<T> extends IParseOptions {
processQueryParams?(data: Unknown): T
}
export function useQueryParams<T = unknown>(options?: UseQueryParamsOptions<T>): T {
const { search } = useLocation()
const queryParams = React.useMemo(() => {
const params = qs.parse(search, { ignoreQueryPrefix: true, ...options })
if (typeof options?.processQueryParams === 'function') {
return options.processQueryParams(params)
}
return params
}, [search, options])
return queryParams as unknown as T
}