diff options
| author | Armand Philippot <git@armandphilippot.com> | 2023-10-26 19:07:31 +0200 |
|---|---|---|
| committer | Armand Philippot <git@armandphilippot.com> | 2023-11-11 18:15:27 +0100 |
| commit | 795b92cc1a168c48c7710ca6e0e1ef5974013d95 (patch) | |
| tree | 8f57204b0ffe7c8acb3203a24292f375377b6369 /src/utils/hooks/use-local-storage.tsx | |
| parent | 9aeb82269d7c74c4566b7ca254782a4dfbd69a6e (diff) | |
refactor(hooks): rewrite useLocalStorage hook
* return a tuple instead of an object
* add a validator function as parameter (if the stored value
is manually changed, it is not safe to cast its type)
* add tests
Diffstat (limited to 'src/utils/hooks/use-local-storage.tsx')
| -rw-r--r-- | src/utils/hooks/use-local-storage.tsx | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/src/utils/hooks/use-local-storage.tsx b/src/utils/hooks/use-local-storage.tsx deleted file mode 100644 index 0f9fbb6..0000000 --- a/src/utils/hooks/use-local-storage.tsx +++ /dev/null @@ -1,33 +0,0 @@ -import { LocalStorage } from '../../services/local-storage'; -import { Dispatch, SetStateAction, useEffect, useState } from 'react'; - -export type UseLocalStorageReturn<T> = { - value: T; - setValue: Dispatch<SetStateAction<T>>; -}; - -/** - * Use the local storage. - * - * @param {string} key - The storage local key. - * @param {T} [fallbackValue] - A fallback value if local storage is empty. - * @returns {UseLocalStorageReturn<T>} An object with value and setValue. - */ -export const useLocalStorage = <T,>( - key: string, - fallbackValue: T -): UseLocalStorageReturn<T> => { - const getInitialValue = () => { - if (typeof window === 'undefined') return fallbackValue; - const storedValue = LocalStorage.get<T>(key); - return storedValue ?? fallbackValue; - }; - - const [value, setValue] = useState<T>(getInitialValue); - - useEffect(() => { - LocalStorage.set(key, value); - }, [key, value]); - - return { value, setValue }; -}; |
