query-string

https://www.npmjs.com/package/query-string
Admin
A library for parsing and stringifying URL query strings with support for multiple array formats and...
Tokens:58,412
Snippets:724
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install query-string

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Install the query-string package using npm. Ensure you install the correct package and avoid the deprecated 'querystring' package.

```bash
npm install query-string
```

--------------------------------

### Basic Usage of query-string

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Demonstrates parsing location.search and location.hash into objects, modifying the object, and stringifying it back into a URL query string. Note that location.search automatically prepends a question mark.

```javascript
import queryString from 'query-string';

console.log(location.search);
//=> '?foo=bar'

const parsed = queryString.parse(location.search);
console.log(parsed);
//=> {foo: 'bar'}

console.log(location.hash);
//=> '#token=bada55cafe'

const parsedHash = queryString.parse(location.hash);
console.log(parsedHash);
//=> {token: 'bada55cafe'}

parsed.foo = 'unicorn';
parsed.ilike = 'pizza';

const stringified = queryString.stringify(parsed);
//=> 'foo=unicorn&ilike=pizza'

location.search = stringified;
// note that `location.search` automatically prepends a question mark
console.log(location.search);
//=> '?foo=unicorn&ilike=pizza'
```

--------------------------------

### Extract Query String from URL

Source: https://www.npmjs.com/package/query-string

Use `.extract()` to get only the query string part from a given URL.

```javascript
queryString.extract('https://foo.bar?foo=bar');
//=> 'foo=bar'
```

--------------------------------

### Nesting and Multiple Keys

Source: https://www.npmjs.com/package/query-string/v/9.0.0

Demonstrates how the library handles nested objects by JSON stringification and how multiple keys with the same name are parsed and stringified.

```APIDOC
## Nesting
This module intentionally doesn't support nesting as it's not spec'd and varies between implementations, which causes a lot of edge cases.
You're much better off just converting the object to a JSON string:
```javascript
import queryString from 'query-string';

queryString.stringify({
	foo: 'bar',
	nested: JSON.stringify({
		unicorn: 'cake'
	})
});
//=> 'foo=bar&nested=%7B%22unicorn%22%3A%22cake%22%7D'
```

However, there is support for multiple instances of the same key:
```javascript
import queryString from 'query-string';

queryString.parse('likes=cake&name=bob&likes=icecream');
//=> {likes: ['cake', 'icecream'], name: 'bob'}

queryString.stringify({color: ['taupe', 'chartreuse'], id: '515'});
//=> 'color=taupe&color=chartreuse&id=515'
```
```

--------------------------------

### .pick(url, keys, options?) / .pick(url, filter, options?)

Source: https://www.npmjs.com/package/query-string/v/9.1.2?activeTab=dependencies

Picks query parameters from a URL based on provided keys or a filter function. Returns a new URL string with only the selected parameters.

```APIDOC
## .pick(url, keys, options?) / .pick(url, filter, options?)

Picks query parameters from a URL.

### Parameters
#### Path Parameters
- **url** (string) - Required - The URL containing the query parameters to pick.
- **keys** (string[]) - Required - The names of the query parameters to pick.
- **filter** (function) - Required - A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### Query Parameters
- **options** (object) - Optional - Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### .pick(url, keys, options?) / .pick(url, filter, options?)

Source: https://www.npmjs.com/package/query-string/v/9.1.2

Picks specified query parameters from a URL based on provided keys or a filter function. Returns a new URL string with only the selected parameters.

```APIDOC
## .pick(url, keys, options?) / .pick(url, filter, options?)

### Description
Pick query parameters from a URL.
Returns a string with the new URL.

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.
#### keys
Type: `string[]`
The names of the query parameters to filter.
#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### pick

Source: https://www.npmjs.com/package/query-string/v/9.2.2?activeTab=code

Picks specified query parameters from a URL, returning a new URL string with only the selected parameters.

```APIDOC
## .pick(url, keys, options?)
## .pick(url, filter, options?)

Pick query parameters from a URL.
Returns a string with the new URL.

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.
#### keys
Type: `string[]`
The names of the query parameters to filter based on the function used.
#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### pick

Source: https://www.npmjs.com/package/query-string/v/9.1.2?activeTab=versions

Picks specified query parameters from a URL, returning a new URL string with only the selected parameters.

```APIDOC
## .pick(url, keys, options?)
## .pick(url, filter, options?)

Picks query parameters from a URL based on provided keys or a filter function.

### Parameters
#### url (string)

The URL containing the query parameters to pick from.

#### keys (string[])

An array of query parameter names to pick.

#### filter ((key, value) => boolean)

A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.

#### options (object, optional)

Parse options and stringify options.

### Returns

A string with the new URL containing only the picked query parameters.

### Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### .pick(url, keys, options?) / .pick(url, filter, options?)

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=code

Selects specific query parameters from a URL based on provided keys or a filter function. Returns a new URL string with only the selected parameters.

```APIDOC
## .pick(url, keys, options?)
## .pick(url, filter, options?)

### Description
Pick query parameters from a URL. Returns a string with the new URL.

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.

#### keys
Type: `string[]`
The names of the query parameters to filter.

#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.

#### options
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```

### Response
#### Success Response (200)
- **string** - The URL with only the picked query parameters.

#### Response Example
```json
{
  "example": "https://foo.bar?foo=1#hello"
}
```
```

--------------------------------

### .pick(url, keys, options?) / .pick(url, filter, options?)

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=versions

Selects specific query parameters from a URL based on provided keys or a filter function. Returns a new URL string with only the selected parameters.

```APIDOC
## .pick(url, keys, options?) / .pick(url, filter, options?)

### Description
Pick query parameters from a URL. Returns a string with the new URL.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.
#### keys
Type: `string[]`
The names of the query parameters to pick.
#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```

### Response
#### Success Response (200)
- `string` - The new URL with picked query parameters.

#### Response Example
```json
"https://foo.bar?foo=1#hello"
```
```

--------------------------------

### arrayFormat Options

Source: https://www.npmjs.com/package/query-string?activeTab=readme

Demonstrates different ways to serialize arrays in query strings using the `arrayFormat` option.

```APIDOC
## arrayFormat
Type: `string`
Default: `'none'`

* `'bracket'`: Serialize arrays using bracket representation.
```javascript
import queryString from 'query-string';

queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket'});
//=> 'foo[]=1&foo[]=2&foo[]=3'
```

* `'index'`: Serialize arrays using index representation.
```javascript
import queryString from 'query-string';

queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'index'});
//=> 'foo[0]=1&foo[1]=2&foo[2]=3'
```

* `'comma'`: Serialize arrays by separating elements with comma.
```javascript
import queryString from '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 a custom character.
```javascript
import queryString from 'query-string';

queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'separator', arrayFormatSeparator: '|'});
//=> 'foo=1|2|3'
```

* `'bracket-separator'`: Serialize arrays by explicitly post-fixing array names with brackets and separating elements with a custom character.
```javascript
import queryString from 'query-string';

queryString.stringify({foo: []}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> 'foo[]'

queryString.stringify({foo: ['']}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> 'foo[]='

queryString.stringify({foo: [1]}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> 'foo[]=1'

queryString.stringify({foo: [1, 2, 3]}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> 'foo[]=1|2|3'

queryString.stringify({foo: [1, '', 3, null, null, 6]}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> 'foo[]=1||3|||6'

queryString.stringify({foo: [1, '', 3, null, null, 6]}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|', skipNull: true});
//=> 'foo[]=1||3|6'

queryString.stringify({foo: [1, 2, 3], bar: 'fluffy', baz: [4]}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> 'foo[]=1|2|3&bar=fluffy&baz[]=4'
```

* `'colon-list-separator'`: Serialize arrays with parameter names that are explicitly marked with `:list`.
```javascript
import queryString from 'query-string';

queryString.stringify({foo: ['one', 'two']}, {arrayFormat: 'colon-list-separator'});
//=> 'foo:list=one&foo:list=two'
```

* `'none'`: Serialize arrays by using duplicate keys.
```javascript
import queryString from 'query-string';

queryString.stringify({foo: [1, 2, 3]});
//=> 'foo=1&foo=2&foo=3'
```
```

--------------------------------

### Pick Query Parameters by Key or Filter

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=code

Use `pick` to select specific query parameters from a URL. You can provide an array of keys or a filter function. Options like `parseNumbers` can affect value comparison.

```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```

--------------------------------

### stringify Options

Source: https://www.npmjs.com/package/query-string/v/9.0.0

The `stringify` function accepts an options object to customize its behavior. Below are the available options and their effects.

```APIDOC
## Options for `queryString.stringify`

### `strict`

*   **Type:** `boolean`
*   **Default:** `true`
*   **Description:** Strictly encode URI components. Uses `encodeURIComponent` if set to `false`. This option is generally not critical for most use cases.

### `encode`

*   **Type:** `boolean`
*   **Default:** `true`
*   **Description:** Controls whether keys and values in the query string are URL encoded.

### `arrayFormat`

*   **Type:** `string`
*   **Default:** `'none'`
*   **Description:** Specifies how arrays should be serialized. Supported values include:
    *   `'bracket'`: `foo[]=1&foo[]=2&foo[]=3`
    *   `'index'`: `foo[0]=1&foo[1]=2&foo[2]=3`
    *   `'comma'`: `foo=1,2,3` (Note: `null` and empty string values might be lost or parsed differently).
    *   `'separator'`: `foo=1|2|3` (Requires `arrayFormatSeparator` to be set).
    *   `'bracket-separator'`: `foo[]=1|2|3` (Requires `arrayFormatSeparator` to be set).
    *   `'colon-list-separator'`: `foo:list=one&foo:list=two`
    *   `'none'`: `foo=1&foo=2&foo=3` (Duplicate keys).

### `arrayFormatSeparator`

*   **Type:** `string`
*   **Default:** `','`
*   **Description:** The character used to separate array elements when `arrayFormat` is set to `'separator'` or `'bracket-separator'`.

### `sort`

*   **Type:** `Function | boolean`
*   **Default:** `Array#sort()` (string Unicode code point order)
*   **Description:** Allows custom sorting of keys. Can be a function for custom sorting logic or `false` to disable sorting.
    *   Example with custom sort function:
        ```javascript
        import queryString from 'query-string';
        const order = ['c', 'a', 'b'];
        queryString.stringify({a: 1, b: 2, c: 3}, {
          sort: (a, b) => order.indexOf(a) - order.indexOf(b)
        });
        //=> 'c=3&a=1&b=2'
        ```
    *   Example disabling sort:
        ```javascript
        import queryString from 'query-string';
        queryString.stringify({b: 1, c: 2, a: 3}, {sort: false});
        //=> 'b=1&c=2&a=3'
        ```

### `skipNull`

*   **Type:** `boolean`
*   **Default:** `false`
*   **Description:** Skips keys where the value is `null`. Keys with `undefined` values are always skipped.
    *   Example:
        ```javascript
        import queryString from 'query-string';
        queryString.stringify({a: 1, b: undefined, c: null, d: 4}, {
          skipNull: true
        });
        //=> 'a=1&d=4'
        ```

### `skipEmptyString`

*   **Type:** `boolean`
*   **Default:** `false`
*   **Description:** Skips keys where the value is an empty string (`''`).
    *   Example:
        ```javascript
        import queryString from 'query-string';
        queryString.stringify({a: 1, b: '', c: '', d: 4}, {
          skipEmptyString: true
        });
        //=> 'a=1&d=4'
        ```
```

--------------------------------

### queryString.pick(url, keys | filter, options?)

Source: https://www.npmjs.com/package/query-string/v/9.2.2

Picks query parameters from a URL based on provided keys or a filter function. Returns a string with the new URL.

```APIDOC
## .pick(url, keys, options?)
## .pick(url, filter, options?)

Picks query parameters from a URL.
Returns a string with the new URL.

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.
#### keys
Type: `string[]`
The names of the query parameters to filter based on the function used.
#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### .pick(url, keys, options?) / .pick(url, filter, options?)

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Selects specific query parameters from a URL based on provided keys or a filter function. Returns the modified URL string.

```APIDOC
## .pick(url, keys, options?)
## .pick(url, filter, options?)

### Description
Pick query parameters from a URL. Returns a string with the new URL.

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.
#### keys
Type: `string[]`
The names of the query parameters to filter based on the function used.
#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### Stringify URL with Query and Fragment

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Use `stringifyUrl` to construct a URL from an object containing the base URL, query parameters, and an optional fragment identifier. Query parameters and fragment identifiers provided in the object override those in the base URL.

```javascript
queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'
```

```javascript
queryString.stringifyUrl({url: 'https://foo.bar?foo=baz', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'
```

```javascript
queryString.stringifyUrl({
	url: 'https://foo.bar',
	query: {
		top: 'foo'
	},
	fragmentIdentifier: 'bar'
});
//=> 'https://foo.bar?top=foo#bar'
```

--------------------------------

### Pick Query Parameters by Key

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=dependencies

Extracts specified query parameters from a URL, returning a new URL string. Accepts an array of keys to include.

```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'
```

--------------------------------

### pick

Source: https://www.npmjs.com/package/query-string/v/9.1.2?activeTab=readme

Picks specified query parameters from a URL and returns a new URL string. It can accept an array of keys or a filter function.

```APIDOC
## pick(url, keys, options?)
## pick(url, filter, options?)

### Description
Pick query parameters from a URL. Returns a string with the new URL.

### Parameters
#### url (string)
Type: `string`
The URL containing the query parameters to filter.
#### keys (string[])
Type: `string[]`
The names of the query parameters to filter.
#### filter ((key, value) => boolean)
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options (object?)
Type: `object`
Parse options and stringify options.

### Request Example
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```

### Response
#### Success Response (200)
A string with the new URL containing only the picked query parameters.

#### Response Example
```json
"https://foo.bar?foo=1#hello"
```
```

--------------------------------

### Stringify URL with Basic Query

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=dependencies

Stringifies a URL with a simple query parameter.

```javascript
queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'
```

--------------------------------

### queryString.pick(url, keys | filter, options?)

Source: https://www.npmjs.com/package/query-string

Selects specific query parameters from a URL based on provided keys or a filter function.

```APIDOC
## queryString.pick(url, keys, options?)
## queryString.pick(url, filter, options?)

### Description
Pick query parameters from a URL. Returns a string with the new URL.

### Parameters
#### url
Type: `string`
The URL containing the query parameters to filter.
#### keys
Type: `string[]`
The names of the query parameters to filter based on the function used.
#### filter
Type: `(key, value) => boolean`
A filter predicate that will be provided the name of each query parameter and its value. The `parseNumbers` and `parseBooleans` options also affect `value`.
#### options
Type: `object`
Parse options and stringify options.

### Endpoint
```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```
```

--------------------------------

### Pick Query Parameters from URL

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Use `pick` to extract specific query parameters from a URL. You can provide an array of keys to include or a filter function to dynamically select parameters. Options like `parseNumbers` can be passed.

```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', ['foo']);
//=> 'https://foo.bar?foo=1#hello'
```

```javascript
import queryString from 'query-string';

queryString.pick('https://foo.bar?foo=1&bar=2#hello', (name, value) => value === 2, {parseNumbers: true});
//=> 'https://foo.bar?bar=2#hello'
```

--------------------------------

### Stringify Falsy Values

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Demonstrates how falsy values are stringified. `false` is stringified as 'false', `null` results in the key being present without a value, and `undefined` results in an empty string for the key.

```javascript
import queryString from 'query-string';

queryString.stringify({foo: false});
//=> 'foo=false'

queryString.stringify({foo: null});
//=> 'foo'

queryString.stringify({foo: undefined});
//=> ''
```

--------------------------------

### Handle Multiple Instances of the Same Key

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

The `query-string` module supports multiple values for the same key, parsing them into an array. This is useful for parameters that can appear more than once.

```javascript
import queryString from 'query-string';

queryString.parse('likes=cake&name=bob&likes=icecream');
//=> {likes: ['cake', 'icecream'], name: 'bob'}

queryString.stringify({color: ['taupe', 'chartreuse'], id: '515'});
//=> 'color=taupe&color=chartreuse&id=515'
```

--------------------------------

### skipEmptyString Option

Source: https://www.npmjs.com/package/query-string?activeTab=dependents

When set to `true`, keys with empty string values are omitted from the serialized query string.

```APIDOC
## skipEmptyString Option

### Description
Skip keys with an empty string as the value.

### Default Value:
`false`

### Example Usage:
```javascript
import queryString from 'query-string';

queryString.stringify({a: 1, b: '', c: '', d: 4}, {
	sskipEmptyString: true
});
//=> 'a=1&d=4'

queryString.stringify({a: '', b: ''}, {
	sskipEmptyString: true
});
//=> ''
```
```

--------------------------------

### .parse(string, options?)

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=readme

Parses a URL query string into an object. Leading '?' or '#' characters are ignored. The returned object is created with Object.create(null) and thus does not have a prototype.

```APIDOC
## .parse(string, options?)

### Description
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)` and thus does not have a `prototype`.

### Parameters
#### options
Type: `object`
##### decode
Type: `boolean`
Default: `true`
Decode the keys and values. URL components are decoded with `decode-uri-component`.
##### arrayFormat
Type: `string`
Default: `'none'`
  * `'bracket'`: Parse arrays with bracket representation:
```javascript
import queryString from 'query-string';

queryString.parse('foo[]=1&foo[]=2&foo[]=3', {arrayFormat: 'bracket'});
//=> {foo: ['1', '2', '3']}
```
  * `'index'`: Parse arrays with index representation:
```javascript
import queryString from 'query-string';

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:
```javascript
import queryString from 'query-string';

queryString.parse('foo=1,2,3', {arrayFormat: 'comma'});
//=> {foo: ['1', '2', '3']}
```
  * `'separator'`: Parse arrays with elements separated by a custom character:
```javascript
import queryString from 'query-string';

queryString.parse('foo=1|2|3', {arrayFormat: 'separator', arrayFormatSeparator: '|'});
//=> {foo: ['1', '2', '3']}
```
  * `'bracket-separator'`: Parse arrays (that are explicitly marked with brackets) with elements separated by a custom character:
```javascript
import queryString from 'query-string';

queryString.parse('foo[]', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> {foo: []}

queryString.parse('foo[]=', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> {foo: ['']}

queryString.parse('foo[]=1', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> {foo: ['1']}

queryString.parse('foo[]=1|2|3', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> {foo: ['1', '2', '3']}

queryString.parse('foo[]=1||3|||6', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> {foo: ['1', '', 3, '', '', '6']}

queryString.parse('foo[]=1|2|3&bar=fluffy&baz[]=4', {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
//=> {foo: ['1', '2', '3'], bar: 'fluffy', baz:['4']}
```
  * `'colon-list-separator'`: Parse arrays with parameter names that are explicitly marked with `:list`:
```javascript
import queryString from 'query-string';

queryString.parse('foo:list=one&foo:list=two', {arrayFormat: 'colon-list-separator'});
//=> {foo: ['one', 'two']}
```
  * `'none'`: Parse arrays with elements using duplicate keys:
```javascript
import queryString from 'query-string';

queryString.parse('foo=1&foo=2&foo=3');
//=> {foo: ['1', '2', '3']}
```
##### arrayFormatSeparator
Type: `string`
Default: `','`
The character used to separate array elements when using `{arrayFormat: 'separator'}`.
##### sort
Type: `Function | boolean`
Default: `true`
Supports both `Function` as a custom sorting function or `false` to disable sorting.
##### parseNumbers
Type: `boolean`
Default: `false`
```javascript
import queryString from 'query-string';

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`
Default: `false`
```javascript
import queryString from 'query-string';

queryString.parse('foo=true', {parseBooleans: true});
//=> {foo: true}
```
Parse the value as a boolean type instead of string type if it's a boolean.
```

--------------------------------

### .stringifyUrl(object, options?)

Source: https://www.npmjs.com/package/query-string?activeTab=dependents

Stringifies an object into a URL with a query string, optionally sorting keys and overriding URL components.

```APIDOC
## .stringifyUrl(object, options?)
Stringify an object into a URL with a query string and sorting the keys. The inverse of `.parseUrl()`.

### Parameters
#### Path Parameters
- **object** (object) - The object to stringify.
  ##### url
  Type: `string`
  The URL to stringify.
  ##### query
  Type: `object`
  Query items to add to the URL.
- **options** (object) - Optional. Configuration options, same as for `.stringify()`.

### Returns
(string) The stringified URL with a query string.

### Example
```javascript
import queryString from 'query-string';

queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({url: 'https://foo.bar?foo=baz', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({
	url: 'https://foo.bar',
	query: {
		top: 'foo'
	},
	fragmentIdentifier: 'bar'
});
//=> 'https://foo.bar?top=foo#bar'
```
```

--------------------------------

### skipEmptyString Option

Source: https://www.npmjs.com/package/query-string?activeTab=code

When true, keys with an empty string as the value are omitted from the query string.

```APIDOC
## skipEmptyString Option

### Description
Skip keys with an empty string as the value.

### Type
`boolean`

### Default
`false`

### Example Usage:
```javascript
import queryString from 'query-string';

queryString.stringify({a: 1, b: '', c: '', d: 4}, {
	skipEmptyString: true
});
//=> 'a=1&d=4'

queryString.stringify({a: '', b: ''}, {
	skipEmptyString: true
});
//=> ''
```
```

--------------------------------

### queryString.stringifyUrl(object, options?)

Source: https://www.npmjs.com/package/query-string/v/9.3.1?activeTab=dependents

Constructs a URL with a query string from a given object, allowing for overrides and fragment identifiers.

```APIDOC
## queryString.stringifyUrl(object, options?)

### Description
Stringify an object into a URL with a query string and sorting the keys. The inverse of `.parseUrl()`. The `options` are the same as for `.stringify()`. Returns a string with the URL and a query string. Query items in the `query` property overrides queries in the `url` property. The `fragmentIdentifier` property overrides the fragment identifier in the `url` property.

### Parameters
#### Object
Type: `object`
##### url
Type: `string`
The URL to stringify.
##### query
Type: `object`
Query items to add to the URL.

### Endpoint
```javascript
queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({url: 'https://foo.bar?foo=baz', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({
	url: 'https://foo.bar',
	query: {
		top: 'foo'
	},
	fragmentIdentifier: 'bar'
});
//=> 'https://foo.bar?top=foo#bar'
```
```

--------------------------------

### Parse and Stringify Multiple Instances of Same Key

Source: https://www.npmjs.com/package/query-string/v/9.1.2

Handles multiple values for the same query parameter key by parsing them into an array and stringifying an array into multiple key-value pairs.

```javascript
import queryString from 'query-string';

queryString.parse('likes=cake&name=bob&likes=icecream');
//=> {likes: ['cake', 'icecream'], name: 'bob'}
```

```javascript
queryString.stringify({color: ['taupe', 'chartreuse'], id: '515'});
//=> 'color=taupe&color=chartreuse&id=515'
```

--------------------------------

### .parseUrl(url, options?)

Source: https://www.npmjs.com/package/query-string/v/9.2.2?activeTab=versions

Parses a URL into an object containing the URL, query parameters, and optionally the fragment identifier. The options object can include `parseFragmentIdentifier` to enable parsing of the fragment.

```APIDOC
## .parseUrl(url, options?)

### Description
Parses a URL into an object containing the URL, query parameters, and optionally the fragment identifier.

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to parse.
- **options** (object) - Optional - Options for parsing.
  - **parseFragmentIdentifier** (boolean) - Optional - Default: `false`. Parse the fragment identifier from the URL.

### Response
- **url** (string) - The base URL.
- **query** (object) - An object containing the parsed query parameters.
- **fragmentIdentifier** (string) - Optional - The parsed fragment identifier if `parseFragmentIdentifier` is true.

### Request Example
```javascript
import queryString from 'query-string';

queryString.parseUrl('https://foo.bar?foo=bar#xyz', {parseFragmentIdentifier: true});
//=> {url: 'https://foo.bar', query: {foo: 'bar'}, fragmentIdentifier: 'xyz'}
```
```

--------------------------------

### Stringify URL with Query String

Source: https://www.npmjs.com/package/query-string

Use `.stringifyUrl()` to construct a URL with a query string from an object. Query parameters provided in the `query` property override those in the `url` property.

```javascript
queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({url: 'https://foo.bar?foo=baz', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'
```

--------------------------------

### Stringify Falsy Values: Null

Source: https://www.npmjs.com/package/query-string/v/9.0.0?activeTab=dependencies

Demonstrates how `null` is stringified as a key without a value in the query string.

```javascript
import queryString from 'query-string';

queryString.stringify({foo: null});
//=> 'foo'
```

--------------------------------

### .stringify(object, options?)

Source: https://www.npmjs.com/package/query-string/v/9.1.2

Stringifies an object into a URL query string. It supports various options for formatting arrays and controlling the output.

```APIDOC
## .stringify(object, options?)

### Description
Stringify an object into a URL query string.

### Parameters
#### object
Type: `object`

#### options
Type: `object`

##### arrayFormat
Type: `string`
Default: `'none'`
  * `'bracket'`: Serialize arrays with bracket representation:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['1', '2', '3']}, {arrayFormat: 'bracket'});
    //=> 'foo[]=1&foo[]=2&foo[]=3'
    ```
  * `'index'`: Serialize arrays with index representation:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['1', '2', '3']}, {arrayFormat: 'index'});
    //=> 'foo[0]=1&foo[1]=2&foo[2]=3'
    ```
  * `'comma'`: Serialize arrays with elements separated by comma:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['1', '2', '3']}, {arrayFormat: 'comma'});
    //=> 'foo=1,2,3'
    ```
  * `'separator'`: Serialize arrays with elements separated by a custom character:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['1', '2', '3']}, {arrayFormat: 'separator', arrayFormatSeparator: '|'});
    //=> 'foo=1|2|3'
    ```
  * `'bracket-separator'`: Serialize arrays (that are explicitly marked with brackets) with elements separated by a custom character:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['1', '2', '3']}, {arrayFormat: 'bracket-separator', arrayFormatSeparator: '|'});
    //=> 'foo[]=1|2|3'
    ```
  * `'colon-list-separator'`: Serialize arrays with parameter names that are explicitly marked with `:list`:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['one', 'two']}, {arrayFormat: 'colon-list-separator'});
    //=> 'foo:list=one&foo:list=two'
    ```
  * `'none'`: Serialize arrays with elements using duplicate keys:
    ```
    import queryString from 'query-string';

    queryString.stringify({foo: ['1', '2', '3']});
    //=> 'foo=1&foo=2&foo=3'
    ```

##### arrayFormatSeparator
Type: `string`
Default: `','`
The character used to separate array elements when using `{arrayFormat: 'separator'}`.

##### sort
Type: `Function | boolean`
Default: `true`
Supports both `Function` as a custom sorting function or `false` to disable sorting.

##### encode
Type: `boolean`
Default: `true`
Encode the keys and values. URL components are encoded with `encode-uri-component`.

##### strictNullHandling
Type: `boolean`
Default: `false`
Only include keys that have a value other than `null`.
```
import queryString from 'query-string';

queryString.stringify({foo: null, bar: 'baz'}, {strictNullHandling: true});
//=> 'bar=baz'
```

##### skipNull
Type: `boolean`
Default: `false`
Only include keys that have a value other than `null` or `undefined`.
```
import queryString from 'query-string';

queryString.stringify({foo: undefined, bar: null, baz: 'qux'}, {skipNull: true});
//=> 'baz=qux'
```

##### filter
Type: `Function | string | string[]`
Default: `false`
Filter out keys that are not included in the filter.
```
import queryString from 'query-string';

queryString.stringify({foo: 'bar', baz: 'qux'}, {filter: ['foo']});
//=> 'foo=bar'
```

##### sortInternalArray
Type: `boolean`
Default: `false`
Sort the keys of the internal array.
```
import queryString from 'query-string';

queryString.stringify({foo: ['b', 'a']}, {sortInternalArray: true});
//=> 'foo=a&foo=b'
```
```

--------------------------------

### Falsy Values

Source: https://www.npmjs.com/package/query-string/v/9.0.0

Explains how falsy values (false, null, undefined) are stringified when creating query parameters.

```APIDOC
## Falsy values
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:
```javascript
import queryString from 'query-string';

queryString.stringify({foo: false});
//=> 'foo=false'

queryString.stringify({foo: null});
//=> 'foo'

queryString.stringify({foo: undefined});
//=> ''
```
```

--------------------------------

### .stringifyUrl(object, options?)

Source: https://www.npmjs.com/package/query-string/v/9.3.1?activeTab=readme

Stringifies an object into a URL with a query string, sorting the keys. This is the inverse of .parseUrl().

```APIDOC
## .stringifyUrl(object, options?)

Stringify an object into a URL with a query string and sorting the keys. The inverse of `.parseUrl()`
The `options` are the same as for `.stringify()`. 
Returns a string with the URL and a query string.
Query items in the `query` property overrides queries in the `url` property.
The `fragmentIdentifier` property overrides the fragment identifier in the `url` property.

**Example Usage:**
```javascript
queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({url: 'https://foo.bar?foo=baz', query: {foo: 'bar'}});
//=> 'https://foo.bar?foo=bar'

queryString.stringifyUrl({
  url: 'https://foo.bar',
  query: {
    top: 'foo'
  },
  fragmentIdentifier: 'bar'
});
//=> 'https://foo.bar?top=foo#bar'
```

#### object
Type: `object`
##### url
Type: `string`
The URL to stringify.
##### query
Type: `object`
Query items to add to the URL.
```
Tokens:
Raw