rm-hull / use-local-storage / 18985012008

92%

push

github

feat: add initialValue option to useLocalStorage (#35)

* refactor: Add T constraint to useLocalStorage

The generic type `T` used in `useLocalStorage` is now constrained
to ensure it is a `Record<string, unknown>` or `undefined`. This
improves type safety and clarity.

* feat: add initialValue option to useLocalStorage

Introduces the `initialValue` option to allow providing a
default value if the key is not present in `localStorage`.

This value is used only when the stored item is initially
empty (`null`). If a deserialization error occurs, the value
will remain `undefined` regardless of this option.

* fix: Initialize stored value as empty object

This commit refines how `useLocalStorage` handles the internal stored
value when it is initially `undefined`.

*   Ensure the base object used for updates defaults to `{}` instead
    of relying on `options?.initialValue`. This prevents errors when
    attempting to spread properties onto a non-object base state.
*   Removed `options?.initialValue` from `useEffect` dependencies.
*   Added a type assertion when retrieving the specific key's value.

* Add changeset record

25 of 30 branches covered (83.33%)

Branch coverage included in aggregate %.

59 of 61 relevant lines covered (96.72%)

48.75 hits per line