Skip to content

Commit b1eaa3e

Browse files
committed
Upate hook parameters reference
1 parent 7ba5831 commit b1eaa3e

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

src/useLocalStorageState/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ const [state, setState] = useLocalStorageState(key, { initialState, sync: true }
2626
const [state, setState] = useLocalStorageState(key, { initialState, sync: false });
2727
```
2828

29+
This hook accepts:
2930
- `key` — key for localStorage,
3031
- `options` object:
3132
- `initialState` — initial value of the state if there is no value under `key` in localStorage. If some value is there in localStorage under `key`, then that is used. (default: `undefined`)

0 commit comments

Comments
 (0)