mirror of
https://github.com/notion-enhancer/notion-enhancer.git
synced 2025-04-06 13:39:03 +00:00
66 lines
1.9 KiB
JavaScript
66 lines
1.9 KiB
JavaScript
/**
|
|
* notion-enhancer: api
|
|
* (c) 2021 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/)
|
|
* (https://notion-enhancer.github.io/) under the MIT license
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
/**
|
|
* environment-specific data persistence
|
|
* @namespace storage
|
|
*/
|
|
|
|
import * as storage from '../env/storage.mjs';
|
|
|
|
/**
|
|
* get persisted data
|
|
* @type {function}
|
|
* @param {string[]} path - the path of keys to the value being fetched
|
|
* @param {unknown=} fallback - a default value if the path is not matched
|
|
* @returns {Promise} value ?? fallback
|
|
*/
|
|
export const get = storage.get;
|
|
|
|
/**
|
|
* persist data
|
|
* @type {function}
|
|
* @param {string[]} path - the path of keys to the value being set
|
|
* @param {unknown} value - the data to save
|
|
* @returns {Promise} resolves when data has been saved
|
|
*/
|
|
export const set = storage.set;
|
|
|
|
/**
|
|
* create a wrapper for accessing a partition of the storage
|
|
* @type {function}
|
|
* @param {string[]} namespace - the path of keys to prefix all storage requests with
|
|
* @param {function=} get - the storage get function to be wrapped
|
|
* @param {function=} set - the storage set function to be wrapped
|
|
* @returns {object} an object with the wrapped get/set functions
|
|
*/
|
|
export const db = storage.db;
|
|
|
|
/**
|
|
* add an event listener for changes in storage
|
|
* @type {function}
|
|
* @param {onStorageChangeCallback} callback - called whenever a change in
|
|
* storage is initiated from the current process
|
|
*/
|
|
export const addChangeListener = storage.addChangeListener;
|
|
|
|
/**
|
|
* remove a listener added with storage.addChangeListener
|
|
* @type {function}
|
|
* @param {onStorageChangeCallback} callback
|
|
*/
|
|
export const removeChangeListener = storage.removeChangeListener;
|
|
|
|
/**
|
|
* @callback onStorageChangeCallback
|
|
* @param {object} event
|
|
* @param {string} event.path- the path of keys to the changed value
|
|
* @param {string=} event.new - the new value being persisted to the store
|
|
* @param {string=} event.old - the previous value associated with the key
|
|
*/
|