dragonwocky/notion-enhancer
1
0
Fork 0
mirror of https://github.com/notion-enhancer/notion-enhancer.git synced 2025-04-05 05:09:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

env jsdoc changes

Browse Source
This commit is contained in:
dragonwocky 2021-12-24 23:30:55 +11:00
parent 88acc12530
commit e84967ae6c
Signed by: dragonwocky
GPG Key ID: 86DFC3C312A56010
3 changed files with 18 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
insert/env/env.mjs vendored
View File

@ -6,10 +6,7 @@
'use strict'; '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 * the environment/platform name code is currently being executed in

17
insert/env/fs.mjs vendored
View File

@ -6,15 +6,12 @@
'use strict'; 'use strict';
/** /** environment-specific file reading */
* environment-specific file reading
* @module notion-enhancer/api/fs
*/
/** /**
* get an absolute path to files within notion * get an absolute path to files within notion
* @param {string} path - relative to the root notion/resources/app/ e.g. renderer/search.js * @param {string} path - relative to the root notion/resources/app/ e.g. renderer/search.js
* @runtime electron * @process electron
*/ */
export const notionPath = globalThis.__enhancerElectronApi.notionPath; export const notionPath = globalThis.__enhancerElectronApi.notionPath;
@ -28,7 +25,7 @@ export const localPath = (path) => `notion://www.notion.so/__notion-enhancer/${p
/** /**
* fetch and parse a json file's contents * fetch and parse a json file's contents
* @param {string} path - a url or within-the-enhancer filepath * @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 * @returns {object} the json value of the requested file as a js object
*/ */
export const getJSON = (path, opts = {}) => { export const getJSON = (path, opts = {}) => {
@ -37,7 +34,7 @@ export const getJSON = (path, opts = {}) => {
if (networkPath) return fetch(path, opts).then((res) => res.json()); if (networkPath) return fetch(path, opts).then((res) => res.json());
try { try {
return globalThis.__enhancerElectronApi.nodeRequire(`notion-enhancer/${path}`); return globalThis.__enhancerElectronApi.nodeRequire(`notion-enhancer/${path}`);
} catch (err) { } catch {
return fetch(localPath(path), opts).then((res) => res.json()); return fetch(localPath(path), opts).then((res) => res.json());
} }
}; };
@ -45,7 +42,7 @@ export const getJSON = (path, opts = {}) => {
/** /**
* fetch a text file's contents * fetch a text file's contents
* @param {string} path - a url or within-the-enhancer filepath * @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 * @returns {string} the text content of the requested file
*/ */
export const getText = (path, opts = {}) => { export const getText = (path, opts = {}) => {
@ -55,7 +52,7 @@ export const getText = (path, opts = {}) => {
try { try {
const fs = globalThis.__enhancerElectronApi.nodeRequire('fs'); const fs = globalThis.__enhancerElectronApi.nodeRequire('fs');
return fs.readFileSync(notionPath(`notion-enhancer/${path}`)); return fs.readFileSync(notionPath(`notion-enhancer/${path}`));
} catch (err) { } catch {
return fetch(localPath(path), opts).then((res) => res.text()); return fetch(localPath(path), opts).then((res) => res.text());
} }
}; };
@ -73,7 +70,7 @@ export const isFile = async (path) => {
} else { } else {
try { try {
fs.existsSync(notionPath(`notion-enhancer/${path}`)); fs.existsSync(notionPath(`notion-enhancer/${path}`));
} catch (err) { } catch {
await fetch(localPath(path)); await fetch(localPath(path));
} }
} }

23
insert/env/storage.mjs vendored
View File

@ -6,15 +6,12 @@
'use strict'; 'use strict';
/** /** environment-specific data persistence */
* environment-specific data persistence
* @module notion-enhancer/api/storage
*/
/** /**
* get persisted data * 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 * @returns {Promise} value ?? fallback
*/ */
export const get = (path, fallback = undefined) => { export const get = (path, fallback = undefined) => {
@ -23,8 +20,8 @@ export const get = (path, fallback = undefined) => {
/** /**
* persist data * 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 * @returns {Promise} resolves when data has been saved
*/ */
export const set = (path, value) => { export const set = (path, value) => {
@ -33,9 +30,9 @@ export const set = (path, value) => {
/** /**
* create a wrapper for accessing a partition of the storage * 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 * @returns {object} an object with the wrapped get/set functions
*/ */
export const db = (namespace, getFunc = get, setFunc = set) => { export const db = (namespace, getFunc = get, setFunc = set) => {
@ -67,6 +64,6 @@ export const removeChangeListener = (callback) => {
* @callback onStorageChangeCallback * @callback onStorageChangeCallback
* @param {object} event * @param {object} event
* @param {string} event.path- the path of keys to the changed value * @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
*/ */