resin-settings-storage v4.0.1

resin-settings-storage

Join our online chat at

Resin.io settings storage utilities.

Role

The intention of this module is to provide low level access to how a Resin.io persists settings in both the filesystem and the browser.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Unless you know what you're doing, use the Resin SDK instead.

Installation

Install resin-settings-storage by running:

$ npm install --save resin-settings-storage

Documentation

• storage
  • .getStorage(options) ⇒ storage
    • ~set(name, value) ⇒ Promise
    • ~get(name) ⇒ Promise.<*>
    • ~has(name) ⇒ Promise.<Boolean>
    • ~remove(name) ⇒ Promise
    • ~clear() ⇒ Promise

storage.getStorage(options) ⇒ storage

Kind: static method of storage
Summary: Get an instance of storage module
Access: public

Example

const storage = require('resin-settings-storage')({
	dataDirectory: '/opt/cache/resin'
})

• .getStorage(options) ⇒ storage
  • ~set(name, value) ⇒ Promise
  • ~get(name) ⇒ Promise.<*>
  • ~has(name) ⇒ Promise.<Boolean>
  • ~remove(name) ⇒ Promise
  • ~clear() ⇒ Promise

getStorage~set(name, value) ⇒ Promise

Kind: inner method of getStorage
Summary: Set a value
Access: public

Example

storage.set('token', '1234')

getStorage~get(name) ⇒ Promise.<*>

Kind: inner method of getStorage
Summary: Get a value
Returns: Promise.<*> - value or undefined
Access: public

Example

storage.get('token').then((token) => {
	console.log(token)
});

getStorage~has(name) ⇒ Promise.<Boolean>

Kind: inner method of getStorage
Summary: Check if the value exists
Returns: Promise.<Boolean> - has value
Access: public

Example

storage.has('token').then((hasToken) => {
	if (hasToken) {
		console.log('Yes')
	} else {
		console.log('No')
});

getStorage~remove(name) ⇒ Promise

Kind: inner method of getStorage
Summary: Remove a value
Access: public

Example

storage.remove('token')

getStorage~clear() ⇒ Promise

Kind: inner method of getStorage
Summary: Remove all values
Access: public
Example

storage.clear()

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

$ npm test

Contribute

• Issue Tracker: github.com/resin-io-modules/resin-settings-storage/issues
• Source Code: github.com/resin-io-modules/resin-settings-storage

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ npm run lint

License

The project is licensed under the Apache 2.0 license.