2021-10-17 18:26:00 +02:00
|
|
|
---
|
2022-09-29 23:03:28 +02:00
|
|
|
title: Store.get()
|
2021-10-17 18:26:00 +02:00
|
|
|
---
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2022-09-29 23:03:28 +02:00
|
|
|
The `Store.get()` method retrieves the data available under `key`.
|
|
|
|
|
|
|
|
## Signature
|
|
|
|
|
|
|
|
```js
|
|
|
|
mixed store.get(mixed key, mixed dflt)
|
|
|
|
```
|
|
|
|
|
|
|
|
If `key` is not available, the Store will return the optional second parameter
|
|
|
|
(a default value).
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
2021-08-25 16:09:31 +02:00
|
|
|
```js
|
2022-09-29 23:03:28 +02:00
|
|
|
const store = new Store()
|
|
|
|
store.set('example', 'Hi there')
|
|
|
|
const value = store.get('example')
|
|
|
|
// value now holds 'Hi there'
|
2021-08-25 16:09:31 +02:00
|
|
|
```
|
|
|
|
|
2022-09-29 23:03:28 +02:00
|
|
|
## Notes
|
|
|
|
|
|
|
|
You can get/set nested keys either through dot-notation, or by passing an
|
|
|
|
array:
|
|
|
|
|
|
|
|
```js
|
|
|
|
const store = new Store()
|
|
|
|
|
|
|
|
store.set('my.nested.example', 'Hi there')
|
|
|
|
store.set(['my', 'other', 'nested', 'example'], 'Oh hi again')
|
|
|
|
|
|
|
|
let value
|
|
|
|
// Dot notation
|
|
|
|
value = store.get('my.nested.example') // works
|
|
|
|
value = store.get('my.other.nested.example') // works
|
|
|
|
// Using an array
|
|
|
|
value = store.get(['my', 'nested', 'example']) // works
|
|
|
|
value = store.get(['my', 'other', 'nested', 'example']) // works
|
|
|
|
// Direct access to the store object
|
|
|
|
value = store.my.nested.example // Also works
|
|
|
|
value = store.my.other.nested.example // Also works
|
|
|
|
```
|