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

100% Statements 8/8
100% Branches 0/0
100% Functions 2/2
100% Lines 8/8

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              1071x 1071x                           1071x 6283x 6283x     1071x 1377x 1377x    
/*
 * 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 { useContext } from 'react'
import { AppStoreContext, FeatureFlagMap } from 'framework/AppStore/AppStoreContext'
import type { FeatureFlag } from '@common/featureFlags'
 
/**
 * Usage if you need a single flag:
 *
 * const enabled = useFeatureFlag("FLAG_NAME")
 *
 * OR, if you need multiple flags:
 *
 * const { FLAG_NAME_1, FLAG_NAME_2 } = useFeatureFlags()
 *
 */
 
export function useFeatureFlag(flag: FeatureFlag): boolean {
  const { featureFlags } = useContext(AppStoreContext)
  return !!featureFlags[flag]
}
 
export function useFeatureFlags(): FeatureFlagMap {
  const { featureFlags } = useContext(AppStoreContext)
  return featureFlags
}