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

100% Statements 6/6
100% Branches 0/0
100% Functions 2/2
100% Lines 5/5

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              26x                   26x 9x 9x   9x    
/*
 * 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 { useParams } from 'react-router-dom'
import type { ModuleName as ModuleNameEnum } from 'framework/types/ModuleName'
 
type ModuleName = Exclude<keyof typeof ModuleNameEnum, 'COMMON' | 'FRAMEWORK' | 'DX'>
 
export interface UseCurrentModulePayload {
  module: string | undefined
  isModule: (moduleName: ModuleName) => boolean
}
 
export default function useCurrentModule(): UseCurrentModulePayload {
  const { module } = useParams<{ module: string }>()
  const isModule = (moduleName: ModuleName): boolean => moduleName.toLowerCase() === module
 
  return { module, isModule }
}