All files / hooks use-storage.ts

100% Statements 14/14
100% Branches 2/2
100% Functions 7/7
100% Lines 13/13

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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65                        7x                       1x                                   14x   14x 9x 13x   12x     9x   9x 9x       14x 11x     14x    
import { useEffect, useState } from 'react';
import { RibbonStorage } from '@ribbon-studios/js-utils';
 
export function useLocalStorage<T>(key: string, defaultValue: T): [T, React.Dispatch<React.SetStateAction<T>>];
export function useLocalStorage<T>(
  key: string,
  defaultValue?: T
): [T | null, React.Dispatch<React.SetStateAction<T | null>>];
export function useLocalStorage<T>(
  key: string,
  defaultValue?: T
): [T | null, React.Dispatch<React.SetStateAction<T | null>>] {
  return $useStorage<T>('local', key, defaultValue);
}
 
export function useSessionStorage<T>(key: string, defaultValue: T): [T, React.Dispatch<React.SetStateAction<T>>];
export function useSessionStorage<T>(
  key: string,
  defaultValue?: T
): [T | null, React.Dispatch<React.SetStateAction<T | null>>];
export function useSessionStorage<T>(
  key: string,
  defaultValue?: T
): [T | null, React.Dispatch<React.SetStateAction<T | null>>] {
  return $useStorage<T>('session', key, defaultValue);
}
 
export function $useStorage<T>(
  type: 'local' | 'session',
  key: string,
  defaultValue: T
): [T, React.Dispatch<React.SetStateAction<T>>];
export function $useStorage<T>(
  type: 'local' | 'session',
  key: string,
  defaultValue?: T
): [T | null, React.Dispatch<React.SetStateAction<T | null>>];
export function $useStorage<T>(
  type: 'local' | 'session',
  key: string,
  defaultValue?: T
): [T | null, React.Dispatch<React.SetStateAction<T | null>>] {
  const [value, setValue] = useState<T | null>(RibbonStorage[type].get<T>(key, defaultValue));
 
  useEffect(() => {
    const listener = (event: RibbonStorage.ChangeEvent) => {
      if (event.key !== key) return;
 
      setValue(event.value);
    };
 
    RibbonStorage.on('change', listener);
 
    return () => {
      RibbonStorage.off('change', listener);
    };
  }, [key]);
 
  useEffect(() => {
    RibbonStorage[type].set(key, value);
  }, [type, key, value]);
 
  return [value, setValue] as const;
}