Added JSDoc for json export

ungap · May 11, 2022 · 491a105 · 491a105
1 parent 9ab44fa
commit 491a105
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/cjs/json.js b/cjs/json.js
@@ -7,8 +7,18 @@ const {serialize} = require('./serialize.js');
 const {parse: $parse, stringify: $stringify} = JSON;
 const options = {json: true, lossy: true};
 
+/**
+ * Revive a previously stringified structured clone.
+ * @param {string} str previously stringified data as string.
+ * @returns {any} whatever was previously stringified as clone.
+ */
 const parse = str => deserialize($parse(str));
 exports.parse = parse;
 
-const stringify = str => $stringify(serialize(str, options));
+/**
+ * Represent a structured clone value as string.
+ * @param {any} any some clone-able value to stringify.
+ * @returns {string} the value stringified.
+ */
+const stringify = any => $stringify(serialize(any, options));
 exports.stringify = stringify;
diff --git a/esm/json.js b/esm/json.js
@@ -6,6 +6,16 @@ import {serialize} from './serialize.js';
 const {parse: $parse, stringify: $stringify} = JSON;
 const options = {json: true, lossy: true};
 
+/**
+ * Revive a previously stringified structured clone.
+ * @param {string} str previously stringified data as string.
+ * @returns {any} whatever was previously stringified as clone.
+ */
 export const parse = str => deserialize($parse(str));
 
-export const stringify = str => $stringify(serialize(str, options));
+/**
+ * Represent a structured clone value as string.
+ * @param {any} any some clone-able value to stringify.
+ * @returns {string} the value stringified.
+ */
+export const stringify = any => $stringify(serialize(any, options));