local
Functions that use the localStorage capability in a BrowserWindow to store persistent information. These APIs run in the main node.js process and use IPC to request and transfer information from the browser. This feature is used in conjunction with the weblocal.js file if referenced by a BrowserWindow. weblocal.js should not be loaded into more than one BrowserWindow. This API is intended to mimic the localStorage API available in every Browser, except the getItem() call must be asynchronous and replies with either a callback or a promise.
See: localStorage
- local
- setItem(key, value) ⏏
- removeItem(key) ⏏
- getItem(key, [optionalCallback]) ⇒
Promise.<(string|object)>⏏
setItem(key, value) ⏏
When passed a key name and value, will add that key to the Storage object, or update that key's value if it already exists. This function will not confirm that the key and value were written to the BrowserWindow localStorage.
Kind: Exported function
See: localStorage setItem()
| Param | Type | Description |
|---|---|---|
| key | * |
The name of the key you want to create/update |
| value | * |
The value you want to give the key you are creating/updating |
removeItem(key) ⏏
When passed a key name, will remove that key from the Storage object if it exists. If there is no item associated with the given key, this function will do nothing.
Kind: Exported function
See: localStorage removeItem()
| Param | Type | Description |
|---|---|---|
| key | string |
The name of the key you want to remove |
getItem(key, [optionalCallback]) ⇒ Promise.<(string|object)> ⏏
When passed a key name, will return that key's value, or null if the key does not exist.
Kind: Exported function
Returns: Promise.<(string|object)> - A promise which resolves to containing the value of the key. If the key does not exist, null is returned.
See: localStorage getItem()
| Param | Type | Description |
|---|---|---|
| key | string |
The name of the key you want to retrieve the value of |
| [optionalCallback] | * |
Optional callback function to retreive the |