All files / modules/10-common/hooks useQueryParams.ts

100% Statements 11/11
100% Branches 10/10
100% Functions 2/2
100% Lines 11/11

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32              1076x 1076x 1076x             1076x 4892x   4889x 2035x   2035x 98x     1937x     4889x    
/*
 * Copyright 2021 Harness Inc. All rights reserved.
 * Use of this source code is governed by the PolyForm Shield 1.0.0 license
 * that can be found in the licenses directory at the root of this repository, also available at
 * https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
 */
 
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: any): 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, options?.processQueryParams])
 
  return queryParams as unknown as T
}