Skip to content

docs: Add example for Hooks with default value #834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add example for Hooks with default value #834

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,19 @@ const [age, setAge] = useMMKVNumber('user.age')
const [isMmkvFastAsf, setIsMmkvFastAf] = useMMKVBoolean('is-mmkv-fast-asf')
```

To avoid the possibility of the variable being `undefined` it can be given a default value which will be used in the case that a value is not found for the given `key`.

```js
// default to 'Marc' if 'user.name' key is not found
const [username = 'Marc', setUsername] = useMMKVString('user.name')

// default to 21 if 'user.age' is not found
const [age = 21, setAge] = useMMKVNumber('user.age')

// default to true if 'is-mmkv-fast-asf' is not found
const [isMmkvFastAsf = true, setIsMmkvFastAf] = useMMKVBoolean('is-mmkv-fast-asf')
```

### Keys

```js
Expand Down