docs: correct jsdocs for genObjectFromRaw (resolves #97)

unjs · Dec 16, 2024 · 35c1a2f · 35c1a2f
1 parent 39505b5
commit 35c1a2f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -116,6 +116,8 @@ Generate an ESM `import type` statement.
 
 Serialize an array to a string.
 
+Values are not escaped or quoted.
+
 **Example:**
 
 ```js
@@ -127,21 +129,27 @@ genArrayFromRaw([1, 2, 3])
 
 Serialize an object to a string.
 
+Values are not escaped or quoted.
+
 **Example:**
 
 ```js
-genObjectFromValues({ foo: "bar", test: '() => import("pkg")' })
+genObjectFromRaw({ foo: "bar", test: '() => import("pkg")' })
 // ~> `{ foo: bar, test: () => import("pkg") }`
 ```
 
 ### `genObjectFromRawEntries(array, indent, options)`
 
 Serialize an array of key-value pairs to a string.
 
+Values are not escaped or quoted.
+
 ### `genObjectFromValues(obj, indent, options)`
 
 Serialize an object to a string.
 
+Values are escaped and quoted if necessary.
+
 **Example:**
 
 ```js

diff --git a/src/object.ts b/src/object.ts
@@ -8,10 +8,12 @@ export interface GenObjectOptions extends CodegenOptions {
 /**
  * Serialize an object to a string.
  *
+ * Values are not escaped or quoted.
+ *
  * @example
  *
  * ```js
- * genObjectFromValues({ foo: "bar", test: '() => import("pkg")' })
+ * genObjectFromRaw({ foo: "bar", test: '() => import("pkg")' })
  * // ~> `{ foo: bar, test: () => import("pkg") }`
  * ```
  *
@@ -28,6 +30,8 @@ export function genObjectFromRaw(
 /**
  * Serialize an object to a string.
  *
+ * Values are escaped and quoted if necessary.
+ *
  * @example
  *
  * ```js
@@ -48,6 +52,8 @@ export function genObjectFromValues(
 /**
  * Serialize an array to a string.
  *
+ * Values are not escaped or quoted.
+ *
  * @example
  *
  * ```js
@@ -73,6 +79,8 @@ export function genArrayFromRaw(
 /**
  * Serialize an array of key-value pairs to a string.
  *
+ * Values are not escaped or quoted.
+ *
  * @group serialization
  */
 export function genObjectFromRawEntries(