query-string 7.1.2 → 8.0.0

package/readme.md

@@ -31,15 +31,6 @@
 				<sup>It’s 100% JavaScript, fully customizable, and developer-first.</sup>
 			</div>
 		</a>
-		<br>
-		<a href="https://oss.capital">
-			<div>
-				<img src="https://sindresorhus.com/assets/thanks/oss-capital-logo-white-bg.svg" width="300" alt="OSS Capital">
-			</div>
-			<div>
-				<sup><b>Founded in 2018, OSS Capital is the first and only venture capital platform focused<br>exclusively on supporting early-stage COSS (commercial open source) startup founders.</b></sup>
-			</div>
-		</a>
 	</p>
 </div>
 
@@ -49,18 +40,18 @@
 
 ## Install
 
-```
-$ npm install query-string
+```sh
+npm install query-string
 ```
 
 **Not `npm install querystring`!!!!!**
 
-This module targets Node.js 6 or later and the latest version of Chrome, Firefox, and Safari.
+For browser usage, this package targets the latest version of Chrome, Firefox, and Safari.
 
 ## Usage
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 console.log(location.search);
 //=> '?foo=bar'
@@ -115,7 +106,7 @@ Default: `'none'`
 - `'bracket'`: Parse arrays with bracket representation:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
 //=> {foo: ['1', '2', '3']}
@@ -124,7 +115,7 @@ queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
 - `'index'`: Parse arrays with index representation:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo[0]=1&foo[1]=2&foo[3]=3', {arrayFormat: 'index'});
 //=> {foo: ['1', '2', '3']}
@@ -133,7 +124,7 @@ queryString.parse('foo[0]=1&foo[1]=2&foo[3]=3', {arrayFormat: 'index'});
 - `'comma'`: Parse arrays with elements separated by comma:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
 //=> {foo: ['1', '2', '3']}
@@ -142,7 +133,7 @@ queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
 - `'separator'`: Parse arrays with elements separated by a custom character:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo=1|2|3', {arrayFormat: 'separator', arrayFormatSeparator: '|'});
 //=> {foo: ['1', '2', '3']}
@@ -151,7 +142,7 @@ queryString.parse('foo=1|2|3', {arrayFormat: 'separator', arrayFormatSeparator:
 - `'bracket-separator'`: Parse arrays (that are explicitly marked with brackets) with elements separated by a custom character:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo[]', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
 //=> {foo: []}
@@ -175,7 +166,7 @@ queryString.parse('foo[]=1|2|3&bar=fluffy&baz[]=4', {arrayFormat: 'bracket-separ
 - `'colon-list-separator'`: Parse arrays with parameter names that are explicitly marked with `:list`:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo:list=one&foo:list=two', {arrayFormat: 'colon-list-separator'});
 //=> {foo: ['one', 'two']}
@@ -184,7 +175,7 @@ queryString.parse('foo:list=one&foo:list=two', {arrayFormat: 'colon-list-separat
 - `'none'`: Parse arrays with elements using duplicate keys:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo=1&foo=2&foo=3');
 //=> {foo: ['1', '2', '3']}
@@ -210,7 +201,7 @@ Type: `boolean`\
 Default: `false`
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo=1', {parseNumbers: true});
 //=> {foo: 1}
@@ -224,7 +215,7 @@ Type: `boolean`\
 Default: `false`
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('foo=true', {parseBooleans: true});
 //=> {foo: true}
@@ -262,7 +253,7 @@ Default: `'none'`
 - `'bracket'`: Serialize arrays using bracket representation:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket'});
 //=> 'foo[]=1&foo[]=2&foo[]=3'
@@ -271,7 +262,7 @@ queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket'});
 - `'index'`: Serialize arrays using index representation:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
 //=> 'foo[0]=1&foo[1]=2&foo[2]=3'
@@ -280,7 +271,7 @@ queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
 - `'comma'`: Serialize arrays by separating elements with comma:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'comma'});
 //=> 'foo=1,2,3'
@@ -294,7 +285,7 @@ queryString.stringify({foo: [1, null, '']}, {arrayFormat: 'comma'});
 - `'separator'`: Serialize arrays by separating elements with a custom character:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'separator', arrayFormatSeparator: '|'});
 //=> 'foo=1|2|3'
@@ -303,7 +294,7 @@ queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'separator', arrayFormatSe
 - `'bracket-separator'`: Serialize arrays by explicitly post-fixing array names with brackets and separating elements with a custom character:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: []}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
 //=> 'foo[]'
@@ -330,7 +321,7 @@ queryString.stringify({foo: [1, 2, 3], bar: 'fluffy', baz: [4]}, {arrayFormat: '
 - `'colon-list-separator'`: Serialize arrays with parameter names that are explicitly marked with `:list`:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: ['one', 'two']}, {arrayFormat: 'colon-list-separator'});
 //=> 'foo:list=one&foo:list=two'
@@ -339,7 +330,7 @@ queryString.stringify({foo: ['one', 'two']}, {arrayFormat: 'colon-list-separator
 - `'none'`: Serialize arrays by using duplicate keys:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: [1, 2, 3]});
 //=> 'foo=1&foo=2&foo=3'
@@ -359,7 +350,7 @@ Type: `Function | boolean`
 Supports both `Function` as a custom sorting function or `false` to disable sorting.
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 const order = ['c', 'a', 'b'];
 
@@ -370,7 +361,7 @@ queryString.stringify({a: 1, b: 2, c: 3}, {
 ```
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({b: 1, c: 2, a: 3}, {sort: false});
 //=> 'b=1&c=2&a=3'
@@ -388,7 +379,7 @@ Type: `boolean`\
 Default: `false`
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({a: 1, b: undefined, c: null, d: 4}, {
 	skipNull: true
@@ -397,7 +388,7 @@ queryString.stringify({a: 1, b: undefined, c: null, d: 4}, {
 ```
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({a: undefined, b: null}, {
 	skipNull: true
@@ -413,7 +404,7 @@ Type: `boolean`\
 Default: `false`
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({a: 1, b: '', c: '', d: 4}, {
 	skipEmptyString: true
@@ -422,7 +413,7 @@ queryString.stringify({a: 1, b: '', c: '', d: 4}, {
 ```
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({a: '', b: ''}, {
 	skipEmptyString: true
@@ -445,7 +436,7 @@ Returns an object with a `url` and `query` property.
 If the `parseFragmentIdentifier` option is `true`, the object will also contain a `fragmentIdentifier` property.
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parseUrl('https://foo.bar?foo=bar');
 //=> {url: 'https://foo.bar', query: {foo: 'bar'}}
@@ -470,7 +461,7 @@ Type: `boolean`\
 Default: `false`
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parseUrl('https://foo.bar?foo=bar#xyz', {parseFragmentIdentifier: true});
 //=> {url: 'https://foo.bar', query: {foo: 'bar'}, fragmentIdentifier: 'xyz'}
@@ -529,7 +520,7 @@ Pick query parameters from a URL.
 Returns a string with the new URL.
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
 //=> 'https://foo.bar?foo=1#hello'
@@ -546,7 +537,7 @@ Exclude query parameters from a URL.
 Returns a string with the new URL.
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.exclude('https://foo.bar?foo=1&bar=2#hello', ['foo']);
 //=> 'https://foo.bar?bar=2#hello'
@@ -586,7 +577,7 @@ This module intentionally doesn't support nesting as it's not spec'd and varies
 You're much better off just converting the object to a JSON string:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({
 	foo: 'bar',
@@ -600,7 +591,7 @@ queryString.stringify({
 However, there is support for multiple instances of the same key:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.parse('likes=cake&name=bob&likes=icecream');
 //=> {likes: ['cake', 'icecream'], name: 'bob'}
@@ -614,7 +605,7 @@ queryString.stringify({color: ['taupe', 'chartreuse'], id: '515'});
 Sometimes you want to unset a key, or maybe just make it present without assigning a value to it. Here is how falsy values are stringified:
 
 ```js
-const queryString = require('query-string');
+import queryString from 'query-string';
 
 queryString.stringify({foo: false});
 //=> 'foo=false'
@@ -631,9 +622,3 @@ queryString.stringify({foo: undefined});
 ### Why is it parsing `+` as a space?
 
 See [this answer](https://github.com/sindresorhus/query-string/issues/305).
-
-## query-string for enterprise
-
-Available as part of the Tidelift Subscription.
-
-The maintainers of query-string and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-query-string?utm_source=npm-query-string&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)