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

81.25% Statements 13/16
100% Branches 7/7
100% Functions 4/4
81.25% Lines 13/16

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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47              1077x       1077x 3x     1077x         52x 31x 31x   31x                 3x 3x   3x 3x             52x    
/*
 * 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 { useState } from 'react'
import type { Dispatch, SetStateAction } from 'react'
 
// eslint-disable-next-line @typescript-eslint/ban-types
export function isFunction(arg: unknown): arg is Function {
  return typeof arg === 'function'
}
 
export function useLocalStorage<T>(
  key: string,
  initalValue: T,
  storage: Storage = window.localStorage
): [T, Dispatch<SetStateAction<T>>] {
  const [state, setState] = useState(() => {
    try {
      const item = storage.getItem(key)
 
      return item && item !== 'undefined' ? JSON.parse(item) : initalValue
    } catch (e) {
      // eslint-disable-next-line no-console
      console.log(e)
      return initalValue
    }
  })
 
  function setItem(value: SetStateAction<T>): void {
    try {
      const valueToSet = isFunction(value) ? value(state) : value
 
      setState(valueToSet)
      storage.setItem(key, JSON.stringify(valueToSet))
    } catch (e) {
      // eslint-disable-next-line no-console
      console.log(e)
    }
  }
 
  return [state, setItem]
}