Fixed documentation for ving/utils/fs readJSON and writeJSON

plainblack · Jun 6, 2024 · 01307d1 · 01307d1
1 parent 146863d
commit 01307d1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/ving/docs/change-log.md b/ving/docs/change-log.md
@@ -4,6 +4,11 @@ outline: deep
 # Change Log
 
 ## June 2024
+
+### 2024-06-06
+* Fixed documentation for ving/utils/fs readJSON and writeJSON
+
+### 2024-06-01
 * Documented noSetAll() attribute in Ving Schemas.
 
 ## May 2024

diff --git a/ving/utils/fs.mjs b/ving/utils/fs.mjs
@@ -40,7 +40,7 @@ export const sanitize = (filename) => {
  * @param {String} path 
  * @returns {object}
  * @example
- * async readJSON('./ving.json')
+ * await readJSON('./ving.json')
  */
 export const readJSON = async (path) => {
     return JSON.parse(await fs.promises.readFile(path));
@@ -51,7 +51,7 @@ export const readJSON = async (path) => {
  * @param {string} path 
  * @param {object} data 
  * @example
- * async writeJSON('./ving.json')
+ * await writeJSON('./ving.json')
  */
 export const writeJSON = async (path, data) => {
     await fs.promises.writeFile(path, JSON.stringify(data, undefined, 2));