query-string 6.7.0 → 6.8.3

package/index.d.ts

@@ -13,28 +13,28 @@ export interface ParseOptions {
 
 		```
 		queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
-		//=> foo: ['1', '2', '3']
+		//=> {foo: ['1', '2', '3']}
 		```
 
 	- `index`: Parse arrays with index representation:
 
 		```
 		queryString.parse('foo[0]=1&foo[1]=2&foo[3]=3', {arrayFormat: 'index'});
-		//=> foo: ['1', '2', '3']
+		//=> {foo: ['1', '2', '3']}
 		```
 
 	- `comma`: Parse arrays with elements separated by comma:
 
 		```
 		queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
-		//=> foo: ['1', '2', '3']
+		//=> {foo: ['1', '2', '3']}
 		```
 
 	- `none`: Parse arrays with elements using duplicate keys:
 
 		```
 		queryString.parse('foo=1&foo=2&foo=3');
-		//=> foo: ['1', '2', '3']
+		//=> {foo: ['1', '2', '3']}
 		```
 	*/
 	readonly arrayFormat?: 'bracket' | 'index' | 'comma' | 'none';
@@ -53,11 +53,11 @@ export interface ParseOptions {
 	queryString.parse('?a=one&b=two&c=three', {
 		sort: (itemLeft, itemRight) => order.indexOf(itemLeft) - order.indexOf(itemRight)
 	});
-	// => {c: 'three', a: 'one', b: 'two'}
+	//=> {c: 'three', a: 'one', b: 'two'}
 	```
 
 	queryString.parse('?a=one&c=three&b=two', {sort: false});
-	// => {a: 'one', c: 'three', b: 'two'}
+	//=> {a: 'one', c: 'three', b: 'two'}
 	```
 	*/
 	readonly sort?: ((itemLeft: string, itemRight: string) => number) | false;
@@ -68,16 +68,29 @@ export interface ParseOptions {
 	@default false
 
 	@example
-	```
-	queryString.parse('foo[]=1&foo[]=2&foo[]=3', {parseNumbers: true});
-	//=> foo: [1, 2, 3]
+	```js
+	queryString.parse('foo=1', {parseNumbers: true});
+	//=> {foo: 1}
 	```
 	*/
 	readonly parseNumbers?: boolean;
+
+	/**
+	Parse the value as a boolean type instead of string type if it's a boolean.
+
+	@default false
+
+	@example
+	```
+	queryString.parse('foo=true', {parseBooleans: true});
+	//=> {foo: true}
+	```
+	*/
+	readonly parseBooleans?: boolean;
 }
 
-export interface ParsedQuery {
-	readonly [key: string]: string | number | Array<string | number> | null | undefined;
+export interface ParsedQuery<T = string> {
+	[key: string]: T | T[] | null | undefined;
 }
 
 /**
@@ -87,6 +100,9 @@ The returned object is created with [`Object.create(null)`](https://developer.mo
 
 @param query - The query string to parse.
 */
+export function parse(query: string, options: {parseBooleans: true, parseNumbers: true} & ParseOptions): ParsedQuery<string | boolean | number>;
+export function parse(query: string, options: {parseBooleans: true} & ParseOptions): ParsedQuery<string | boolean>;
+export function parse(query: string, options: {parseNumbers: true} & ParseOptions): ParsedQuery<string | number>;
 export function parse(query: string, options?: ParseOptions): ParsedQuery;
 
 export interface ParsedUrl {
@@ -136,7 +152,7 @@ export interface StringifyOptions {
 
 		```
 		queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
-		//=> 'foo[0]=1&foo[1]=2&foo[3]=3'
+		//=> 'foo[0]=1&foo[1]=2&foo[2]=3'
 		```
 
 	- `comma`: Serialize arrays by separating elements with comma:
@@ -169,10 +185,10 @@ export interface StringifyOptions {
 	queryString.stringify({a: 1, b: 2, c: 3}, {
 		sort: (itemLeft, itemRight) => order.indexOf(itemLeft) - order.indexOf(itemRight)
 	});
-	// => 'c=3&a=1&b=2'
+	//=> 'c=3&a=1&b=2'
 
 	queryString.stringify({b: 1, c: 2, a: 3}, {sort: false});
-	// => 'b=1&c=2&a=3'
+	//=> 'b=1&c=2&a=3'
 	```
 	*/
 	readonly sort?: ((itemLeft: string, itemRight: string) => number) | false;

package/index.js

@@ -171,12 +171,23 @@ function extract(input) {
 	return input.slice(queryStart + 1);
 }
 
+function parseValue(value, options) {
+	if (options.parseNumbers && !Number.isNaN(Number(value)) && (typeof value === 'string' && value.trim() !== '')) {
+		value = Number(value);
+	} else if (options.parseBooleans && value !== null && (value.toLowerCase() === 'true' || value.toLowerCase() === 'false')) {
+		value = value.toLowerCase() === 'true';
+	}
+
+	return value;
+}
+
 function parse(input, options) {
 	options = Object.assign({
 		decode: true,
 		sort: true,
 		arrayFormat: 'none',
-		parseNumbers: false
+		parseNumbers: false,
+		parseBooleans: false
 	}, options);
 
 	const formatter = parserForArrayFormat(options);
@@ -200,12 +211,18 @@ function parse(input, options) {
 		// Missing `=` should be `null`:
 		// http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
 		value = value === undefined ? null : decode(value, options);
+		formatter(decode(key, options), value, ret);
+	}
 
-		if (options.parseNumbers && !Number.isNaN(Number(value))) {
-			value = Number(value);
+	for (const key of Object.keys(ret)) {
+		const value = ret[key];
+		if (typeof value === 'object' && value !== null) {
+			for (const k of Object.keys(value)) {
+				value[k] = parseValue(value[k], options);
+			}
+		} else {
+			ret[key] = parseValue(value, options);
 		}
-
-		formatter(decode(key, options), value, ret);
 	}
 
 	if (options.sort === false) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "query-string",
-	"version": "6.7.0",
+	"version": "6.8.3",
 	"description": "Parse and stringify URL query strings",
 	"license": "MIT",
 	"repository": "sindresorhus/query-string",

package/readme.md

@@ -72,28 +72,28 @@ Default: `'none'`
 
 ```js
 queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
-//=> foo: ['1', '2', '3']
+//=> {foo: ['1', '2', '3']}
 ```
 
 - `'index'`: Parse arrays with index representation:
 
 ```js
 queryString.parse('foo[0]=1&foo[1]=2&foo[3]=3', {arrayFormat: 'index'});
-//=> foo: ['1', '2', '3']
+//=> {foo: ['1', '2', '3']}
 ```
 
 - `'comma'`: Parse arrays with elements separated by comma:
 
 ```js
 queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
-//=> foo: ['1', '2', '3']
+//=> {foo: ['1', '2', '3']}
 ```
 
 - `'none'`: Parse arrays with elements using duplicate keys:
 
 ```js
 queryString.parse('foo=1&foo=2&foo=3');
-//=> foo: ['1', '2', '3']
+//=> {foo: ['1', '2', '3']}
 ```
 
 ##### sort
@@ -109,12 +109,24 @@ Type: `boolean`<br>
 Default: `false`
 
 ```js
-queryString.parse('foo[]=1&foo[]=2&foo[]=3', {parseNumbers: true});
-//=> foo: [1, 2, 3]
+queryString.parse('foo=1', {parseNumbers: true});
+//=> {foo: 1}
 ```
 
 Parse the value as a number type instead of string type if it's a number.
 
+##### parseBooleans
+
+Type: `boolean`<br>
+Default: `false`
+
+```js
+queryString.parse('foo=true', {parseBooleans: true});
+//=> {foo: true}
+```
+
+Parse the value as a boolean type instead of string type if it's a boolean.
+
 ### .stringify(object, [options])
 
 Stringify an object into a query string and sorting the keys.
@@ -153,7 +165,7 @@ queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket'});
 
 ```js
 queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
-//=> 'foo[0]=1&foo[1]=2&foo[3]=3'
+//=> 'foo[0]=1&foo[1]=2&foo[2]=3'
 ```
 
 - `'comma'`: Serialize arrays by separating elements with comma:
@@ -233,7 +245,7 @@ queryString.parse('likes=cake&name=bob&likes=icecream');
 //=> {likes: ['cake', 'icecream'], name: 'bob'}
 
 queryString.stringify({color: ['taupe', 'chartreuse'], id: '515'});
-//=> 'color=chartreuse&color=taupe&id=515'
+//=> 'color=taupe&color=chartreuse&id=515'
 ```