env jsdoc changes

extension/env/env.mjs

@@ -1,15 +1,12 @@
 /*
- * notion-enhancer core: api
+ * 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 methods and constants */
- * environment-specific methods and constants
- * @module notion-enhancer/api/env
- */
 
 /**
  * the environment/platform name code is currently being executed in

extension/env/fs.mjs

@@ -1,15 +1,12 @@
 /*
- * notion-enhancer core: api
+ * 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 file reading */
- * environment-specific filesystem reading
- * @module notion-enhancer/api/fs
- */
 
 /**
  * transform a path relative to the enhancer root directory into an absolute path
@@ -21,7 +18,7 @@ export const localPath = chrome.runtime.getURL;
 /**
  * fetch and parse a json file's contents
  * @param {string} path - a url or within-the-enhancer filepath
- * @param {object} [opts] - the second argument of a fetch() request
+ * @param {object=} opts - the second argument of a fetch() request
  * @returns {object} the json value of the requested file as a js object
  */
 export const getJSON = (path, opts = {}) =>
@@ -30,7 +27,7 @@ export const getJSON = (path, opts = {}) =>
 /**
  * fetch a text file's contents
  * @param {string} path - a url or within-the-enhancer filepath
- * @param {object} [opts] - the second argument of a fetch() request
+ * @param {object=} opts - the second argument of a fetch() request
  * @returns {string} the text content of the requested file
  */
 export const getText = (path, opts = {}) =>

extension/env/storage.mjs

@@ -1,23 +1,20 @@
 /*
- * notion-enhancer core: api
+ * 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 */
- * environment-specific data persistence
- * @module notion-enhancer/api/storage
- */
 
 const _queue = [],
   _onChangeListeners = [];
 
 /**
  * get persisted data
- * @param {array<string>} path - the path of keys to the value being fetched
+ * @param {string[]} path - the path of keys to the value being fetched
- * @param {*} [fallback] - a default value if the path is not matched
+ * @param {unknown=} fallback - a default value if the path is not matched
  * @returns {Promise} value ?? fallback
  */
 export const get = (path, fallback = undefined) => {
@@ -39,8 +36,8 @@ export const get = (path, fallback = undefined) => {
 
 /**
  * persist data
- * @param {array<string>} path - the path of keys to the value being set
+ * @param {string[]} path - the path of keys to the value being set
- * @param {*} value - the data to save
+ * @param {unknown} value - the data to save
  * @returns {Promise} resolves when data has been saved
  */
 export const set = (path, value) => {
@@ -80,9 +77,9 @@ export const set = (path, value) => {
 
 /**
  * create a wrapper for accessing a partition of the storage
- * @param {array<string>} namespace - the path of keys to prefix all storage requests with
+ * @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=} get - the storage get function to be wrapped
- * @param {function} [set] - the storage set 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 = (namespace, getFunc = get, setFunc = set) => {
@@ -114,6 +111,6 @@ export const removeChangeListener = (callback) => {
  * @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.new - the new value being persisted to the store
- * @param {string} [event.old] - the previous value associated with the key
+ * @param {string=} event.old - the previous value associated with the key
  */