mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-29 23:58:06 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
93 lines
2.0 KiB
JavaScript
93 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 = Boolean(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
|
|
}
|
|
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
|
|
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
|
|
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
|
|
}
|