Sync readme.md and index.d.ts

sindresorhus · Mar 11, 2021 · 4c29858 · 4c29858
1 parent 7a1dfa9
commit 4c29858
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -225,10 +225,15 @@ export interface StringifyOptions {
 	- `comma`: Serialize arrays by separating elements with comma:
 
 		```
-		import queryString = require('query-string');
+		const queryString = require('query-string');
 
 		queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
 		//=> 'foo=1,2,3'
+
+		queryString.stringify({foo: [1, null, '']}, {arrayFormat: 'comma'});
+		//=> 'foo=1,,'
+		// Note that typing information for null values is lost
+		// and `.parse('foo=1,,')` would return `{foo: [1, '', '']}`.
 		```
 
   - `separator`: Serialize arrays by separating elements with character:

diff --git a/readme.md b/readme.md
@@ -231,7 +231,7 @@ queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
 
 queryString.stringify({foo: [1, null, '']}, {arrayFormat: 'comma'});
 //=> 'foo=1,,'
-// Note that typing information for null values are lost
+// Note that typing information for null values is lost
 // and `.parse('foo=1,,')` would return `{foo: [1, '', '']}`.
 ```