drone/web/src/hooks/useQueryParams.ts
2023-09-24 07:33:16 +00:00

41 lines
1.3 KiB
TypeScript

/*
* Copyright 2023 Harness, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import React from 'react'
import { useLocation } from 'react-router-dom'
import qs from 'qs'
import type { IParseOptions } from 'qs'
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
}