1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 12:29:06 +01:00
metamask-extension/app/scripts/lib/local-store.js
Mark Stacey ac01c5c89a
Consistent jsdoc syntax (#7755)
* Specify type before parameter name

Various JSDoc `@param` entries were specified as `name {type}` rather
than `{type} name`.

A couple of `@return` entries have been given types as well.

* Use JSDoc optional syntax rather than Closure syntax

* Use @returns rather than @return

* Use consistent built-in type capitalization

Primitive types are lower-case, and Object is upper-case.

* Separate param/return description with a dash
2020-01-13 14:36:36 -04:00

94 lines
2.0 KiB
JavaScript

import extension from 'extensionizer'
import log from 'loglevel'
import { checkForError } from './util'
/**
* A wrapper around the extension's storage local API
*/
export default class ExtensionStore {
/**
* @constructor
*/
constructor () {
this.isSupported = !!(extension.storage.local)
if (!this.isSupported) {
log.error('Storage local API not available.')
}
}
/**
* Returns all of the keys currently saved
* @returns {Promise<*>}
*/
async get () {
if (!this.isSupported) {
return undefined
}
const result = await this._get()
// extension.storage.local always returns an obj
// if the object is empty, treat it as undefined
if (isEmpty(result)) {
return undefined
} else {
return result
}
}
/**
* Sets the key in local state
* @param {Object} state - The state to set
* @returns {Promise<void>}
*/
async set (state) {
return this._set(state)
}
/**
* Returns all of the keys currently saved
* @private
* @returns {Object} - the key-value map from local storage
*/
_get () {
const local = extension.storage.local
return new Promise((resolve, reject) => {
local.get(null, (/** @type {any} */ result) => {
const err = checkForError()
if (err) {
reject(err)
} else {
resolve(result)
}
})
})
}
/**
* Sets the key in local state
* @param {Object} obj - The key to set
* @returns {Promise<void>}
* @private
*/
_set (obj) {
const local = extension.storage.local
return new Promise((resolve, reject) => {
local.set(obj, () => {
const err = checkForError()
if (err) {
reject(err)
} else {
resolve()
}
})
})
}
}
/**
* Returns whether or not the given object contains no keys
* @param {Object} obj - The object to check
* @returns {boolean}
*/
function isEmpty (obj) {
return Object.keys(obj).length === 0
}