query-string - npm Package Compare versions

Comparing version 6.6.0 to 6.7.0

index.d.ts

 export interface ParseOptions {
 	/**
-	 * Decode the keys and values. URI components are decoded with [`decode-uri-component`](https://github.com/SamVerschueren/decode-uri-component).
-	 *
-	 * @default true
-	 */
+	Decode the keys and values. URI components are decoded with [`decode-uri-component`](https://github.com/SamVerschueren/decode-uri-component).
+
+	@default true
+	*/
 	readonly decode?: boolean;
 
 	/**
-	 * @default 'none'
-	 *
-	 * - `bracket`: Parse arrays with bracket representation:
-	 *
-	 *
-	 *    queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
-	 *    //=> 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]
-	 *
-	 * - `comma`: Parse arrays with elements separated by comma:
-	 *
-	 *
-	 *    queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
-	 *    //=> foo: [1, 2, 3]
-	 *
-	 * - `none`: Parse arrays with elements using duplicate keys:
-	 *
-	 *
-	 *    queryString.parse('foo=1&foo=2&foo=3');
-	 *    //=> foo: [1, 2, 3]
-	 */
+	@default 'none'
+
+	- `bracket`: Parse arrays with bracket representation:
+
+		```
+		queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
+		//=> 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']
+		```
+
+	- `comma`: Parse arrays with elements separated by comma:
+
+		```
+		queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
+		//=> foo: ['1', '2', '3']
+		```
+
+	- `none`: Parse arrays with elements using duplicate keys:
+
+		```
+		queryString.parse('foo=1&foo=2&foo=3');
+		//=> foo: ['1', '2', '3']
+		```
+	*/
 	readonly arrayFormat?: 'bracket' | 'index' | 'comma' | 'none';
 
 	/**
-	 * Supports both `Function` as a custom sorting function or `false` to disable sorting.
-	 *
-	 * If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * const order = ['c', 'a', 'b'];
-	 * queryString.parse('?a=one&b=two&c=three', {
-	 * 	sort: (itemLeft, itemRight) => order.indexOf(itemLeft) - order.indexOf(itemRight)
-	 * });
-	 * // => {c: 'three', a: 'one', b: 'two'}
-	 *
-	 * queryString.parse('?a=one&c=three&b=two', {sort: false});
-	 * // => {a: 'one', c: 'three', b: 'two'}
-	 */
+	Supports both `Function` as a custom sorting function or `false` to disable sorting.
+
+	If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
+
+	@default true
+
+	@example
+	```
+	const order = ['c', 'a', 'b'];
+
+	queryString.parse('?a=one&b=two&c=three', {
+		sort: (itemLeft, itemRight) => order.indexOf(itemLeft) - order.indexOf(itemRight)
+	});
+	// => {c: 'three', a: 'one', b: 'two'}
+	```
+
+	queryString.parse('?a=one&c=three&b=two', {sort: false});
+	// => {a: 'one', c: 'three', b: 'two'}
+	```
+	*/
 	readonly sort?: ((itemLeft: string, itemRight: string) => number) | false;
 
+	/**
+	Parse the value as a number type instead of string type if it's a number.
+
+	@default false
+
+	@example
+	```
+	queryString.parse('foo[]=1&foo[]=2&foo[]=3', {parseNumbers: true});
+	//=> foo: [1, 2, 3]
+	```
+	*/
+	readonly parseNumbers?: boolean;
 }
 
 export interface ParsedQuery {
-	readonly [key: string]: string | string[] | null | undefined;
+	readonly [key: string]: string | number | Array<string | number> | null | undefined;
 }
 
 /**
- * Parse a query string into an object. Leading `?` or `#` are ignored, so you can pass `location.search` or `location.hash` directly.
- *
- * The returned object is created with [`Object.create(null)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/create) and thus does not have a `prototype`.
- *
- * @param query - The query string to parse.
- */
+Parse a query string into an object. Leading `?` or `#` are ignored, so you can pass `location.search` or `location.hash` directly.
+
+The returned object is created with [`Object.create(null)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/create) and thus does not have a `prototype`.
+
+@param query - The query string to parse.
+*/
 export function parse(query: string, options?: ParseOptions): ParsedQuery;
@@ -79,11 +98,12 @@
 /**
- * Extract the URL and the query string as an object.
- *
- * @param url - The URL to parse.
- *
- * @example
- *
- * queryString.parseUrl('https://foo.bar?foo=bar');
- * //=> {url: 'https://foo.bar', query: {foo: 'bar'}}
- */
+Extract the URL and the query string as an object.
+
+@param url - The URL to parse.
+
+@example
+```
+queryString.parseUrl('https://foo.bar?foo=bar');
+//=> {url: 'https://foo.bar', query: {foo: 'bar'}}
+```
+*/
 export function parseUrl(url: string, options?: ParseOptions): ParsedUrl;
@@ -93,62 +113,68 @@
 	/**
-	 * Strictly encode URI components with [`strict-uri-encode`](https://github.com/kevva/strict-uri-encode). It uses [`encodeURIComponent`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) if set to `false`. You probably [don't care](https://github.com/sindresorhus/query-string/issues/42) about this option.
-	 *
-	 * @default true
-	 */
+	Strictly encode URI components with [`strict-uri-encode`](https://github.com/kevva/strict-uri-encode). It uses [`encodeURIComponent`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) if set to `false`. You probably [don't care](https://github.com/sindresorhus/query-string/issues/42) about this option.
+
+	@default true
+	*/
 	readonly strict?: boolean;
 
 	/**
-	 * [URL encode](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) the keys and values.
-	 *
-	 * @default true
-	 */
+	[URL encode](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) the keys and values.
+
+	@default true
+	*/
 	readonly encode?: boolean;
 
 	/**
-	 * @default 'none'
-	 *
-	 * - `bracket`: Serialize arrays using bracket representation:
-	 *
-	 *
-	 *    queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket'});
-	 *    //=> 'foo[]=1&foo[]=2&foo[]=3'
-	 *
-	 * - `index`: Serialize arrays using index representation:
-	 *
-	 *
-	 *    queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
-	 *    //=> 'foo[0]=1&foo[1]=2&foo[3]=3'
-	 *
-	 * - `comma`: Serialize arrays by separating elements with comma:
-	 *
-	 *
-	 *    queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
-	 *    //=> 'foo=1,2,3'
-	 *
-	 * - `none`: Serialize arrays by using duplicate keys:
-	 *
-	 *
-	 *    queryString.stringify({foo: [1, 2, 3]});
-	 *    //=> 'foo=1&foo=2&foo=3'
-	 */
+	@default 'none'
+
+	- `bracket`: Serialize arrays using bracket representation:
+
+		```
+		queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket'});
+		//=> 'foo[]=1&foo[]=2&foo[]=3'
+		```
+
+	- `index`: Serialize arrays using index representation:
+
+		```
+		queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
+		//=> 'foo[0]=1&foo[1]=2&foo[3]=3'
+		```
+
+	- `comma`: Serialize arrays by separating elements with comma:
+
+		```
+		queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
+		//=> 'foo=1,2,3'
+		```
+
+	- `none`: Serialize arrays by using duplicate keys:
+
+		```
+		queryString.stringify({foo: [1, 2, 3]});
+		//=> 'foo=1&foo=2&foo=3'
+		```
+	*/
 	readonly arrayFormat?: 'bracket' | 'index' | 'comma' | 'none';
 
 	/**
-	 * Supports both `Function` as a custom sorting function or `false` to disable sorting.
-	 *
-	 * If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
-	 *
-	 * @default true
-	 *
-	 * @example
-	 *
-	 * const order = ['c', 'a', 'b'];
-	 * queryString.stringify({a: 1, b: 2, c: 3}, {
-	 * 	sort: (itemLeft, itemRight) => order.indexOf(itemLeft) - order.indexOf(itemRight)
-	 * });
-	 * // => 'c=3&a=1&b=2'
-	 *
-	 * queryString.stringify({b: 1, c: 2, a: 3}, {sort: false});
-	 * // => 'b=1&c=2&a=3'
-	 */
+	Supports both `Function` as a custom sorting function or `false` to disable sorting.
+
+	If omitted, keys are sorted using `Array#sort`, which means, converting them to strings and comparing strings in Unicode code point order.
+
+	@default true
+
+	@example
+	```
+	const order = ['c', 'a', 'b'];
+
+	queryString.stringify({a: 1, b: 2, c: 3}, {
+		sort: (itemLeft, itemRight) => order.indexOf(itemLeft) - order.indexOf(itemRight)
+	});
+	// => 'c=3&a=1&b=2'
+
+	queryString.stringify({b: 1, c: 2, a: 3}, {sort: false});
+	// => 'b=1&c=2&a=3'
+	```
+	*/
 	readonly sort?: ((itemLeft: string, itemRight: string) => number) | false;
@@ -158,4 +184,4 @@ }
 /**
- * Stringify an object into a query string and sorting the keys.
- */
+Stringify an object into a query string and sort the keys.
+*/
 export function stringify(
@@ -167,4 +193,4 @@ object: {[key: string]: any},
 /**
- * Extract a query string from a URL that can be passed into `.parse()`.
- */
+Extract a query string from a URL that can be passed into `.parse()`.
+*/
 export function extract(url: string): string;

index.js

@@ -178,3 +178,4 @@ 'use strict';
 		sort: true,
-		arrayFormat: 'none'
+		arrayFormat: 'none',
+		parseNumbers: false
 	}, options);
@@ -204,2 +205,6 @@
 
+		if (options.parseNumbers && !Number.isNaN(Number(value))) {
+			value = Number(value);
+		}
+
 		formatter(decode(key, options), value, ret);
@@ -206,0 +211,0 @@ }

package.json

 {
 	"name": "query-string",
-	"version": "6.6.0",
+	"version": "6.7.0",
 	"description": "Parse and stringify URL query strings",
@@ -43,3 +43,3 @@ "license": "MIT",
 	"devDependencies": {
-		"ava": "^2.0.0",
+		"ava": "^1.4.1",
 		"deep-equal": "^1.0.1",
@@ -46,0 +46,0 @@ "fast-check": "^1.5.0",

readme.md

@@ -75,3 +75,3 @@ # query-string [![Build Status](https://travis-ci.org/sindresorhus/query-string.svg?branch=master)](https://travis-ci.org/sindresorhus/query-string)
 queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
-//=> foo: [1, 2, 3]
+//=> foo: ['1', '2', '3']
 ```
@@ -83,3 +83,3 @@
 queryString.parse('foo[0]=1&foo[1]=2&foo[3]=3', {arrayFormat: 'index'});
-//=> foo: [1, 2, 3]
+//=> foo: ['1', '2', '3']
 ```
@@ -91,3 +91,3 @@
 queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
-//=> foo: [1, 2, 3]
+//=> foo: ['1', '2', '3']
 ```
@@ -99,3 +99,3 @@
 queryString.parse('foo=1&foo=2&foo=3');
-//=> foo: [1, 2, 3]
+//=> foo: ['1', '2', '3']
 ```
@@ -110,2 +110,14 @@
 
+##### parseNumbers
+
+Type: `boolean`<br>
+Default: `false`
+
+```js
+queryString.parse('foo[]=1&foo[]=2&foo[]=3', {parseNumbers: true});
+//=> foo: [1, 2, 3]
+```
+
+Parse the value as a number type instead of string type if it's a number.
+
 ### .stringify(object, [options])
@@ -112,0 +124,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19541

increased by2.23%

Number of lines in readme file

267

increased by4.71%

Worsened metrics

Lines of code

360

decreased by-1.37%

Published versions last months

0

decreased by-100%

No dependency changes