ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / share / doc / nodejs-docs-16.20.2 / doc / api

# Query string

> Stability: 3 - Legacy

The `node:querystring` module provides utilities for parsing and formatting URL
query strings. It can be accessed using:

```js
const querystring = require('node:querystring');
```

The `querystring` API is considered Legacy. While it is still maintained,
new code should use the {URLSearchParams} API instead.

## `querystring.decode()`

The `querystring.decode()` function is an alias for `querystring.parse()`.

## `querystring.encode()`

The `querystring.encode()` function is an alias for `querystring.stringify()`.

## `querystring.escape(str)`

* `str` {string}

The `querystring.escape()` method performs URL percent-encoding on the given
`str` in a manner that is optimized for the specific requirements of URL
query strings.

The `querystring.escape()` method is used by `querystring.stringify()` and is
generally not expected to be used directly. It is exported primarily to allow
application code to provide a replacement percent-encoding implementation if
necessary by assigning `querystring.escape` to an alternative function.

## `querystring.parse(str[, sep[, eq[, options]]])`

* `str` {string} The URL query string to parse
* `sep` {string} The substring used to delimit key and value pairs in the
  query string. **Default:** `'&'`.
* `eq` {string}. The substring used to delimit keys and values in the
  query string. **Default:** `'='`.
* `options` {Object}
  * `decodeURIComponent` {Function} The function to use when decoding
    percent-encoded characters in the query string. **Default:**
    `querystring.unescape()`.
  * `maxKeys` {number} Specifies the maximum number of keys to parse.
    Specify `0` to remove key counting limitations. **Default:** `1000`.

The `querystring.parse()` method parses a URL query string (`str`) into a
collection of key and value pairs.

For example, the query string `'foo=bar&abc=xyz&abc=123'` is parsed into:

```js
{
  foo: 'bar',
  abc: ['xyz', '123']
}
```

The object returned by the `querystring.parse()` method _does not_
prototypically inherit from the JavaScript `Object`. This means that typical
`Object` methods such as `obj.toString()`, `obj.hasOwnProperty()`, and others
are not defined and _will not work_.

By default, percent-encoded characters within the query string will be assumed
to use UTF-8 encoding. If an alternative character encoding is used, then an
alternative `decodeURIComponent` option will need to be specified:

```js
// Assuming gbkDecodeURIComponent function already exists...

querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
                  { decodeURIComponent: gbkDecodeURIComponent });
```

## `querystring.stringify(obj[, sep[, eq[, options]]])`

* `obj` {Object} The object to serialize into a URL query string
* `sep` {string} The substring used to delimit key and value pairs in the
  query string. **Default:** `'&'`.
* `eq` {string}. The substring used to delimit keys and values in the
  query string. **Default:** `'='`.
* `options`
  * `encodeURIComponent` {Function} The function to use when converting
    URL-unsafe characters to percent-encoding in the query string. **Default:**
    `querystring.escape()`.

The `querystring.stringify()` method produces a URL query string from a
given `obj` by iterating through the object's "own properties".

It serializes the following types of values passed in `obj`:
{string|number|bigint|boolean|string\[]|number\[]|bigint\[]|boolean\[]}
The numeric values must be finite. Any other input values will be coerced to
empty strings.

```js
querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });
// Returns 'foo=bar&baz=qux&baz=quux&corge='

querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':');
// Returns 'foo:bar;baz:qux'
```

By default, characters requiring percent-encoding within the query string will
be encoded as UTF-8. If an alternative encoding is required, then an alternative
`encodeURIComponent` option will need to be specified:

```js
// Assuming gbkEncodeURIComponent function already exists,

querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
                      { encodeURIComponent: gbkEncodeURIComponent });
```

## `querystring.unescape(str)`

* `str` {string}

The `querystring.unescape()` method performs decoding of URL percent-encoded
characters on the given `str`.

The `querystring.unescape()` method is used by `querystring.parse()` and is
generally not expected to be used directly. It is exported primarily to allow
application code to provide a replacement decoding implementation if
necessary by assigning `querystring.unescape` to an alternative function.

By default, the `querystring.unescape()` method will attempt to use the
JavaScript built-in `decodeURIComponent()` method to decode. If that fails,
a safer equivalent that does not throw on malformed URLs will be used.

[-] async_context.json [edit]
[-] process.md [edit]
[-] tracing.html [edit]
[-] addons.json [edit]
[-] webstreams.html [edit]
[-] debugger.md [edit]
[-] debugger.html [edit]
[-] tls.json [edit]
[-] inspector.md [edit]
[-] child_process.json [edit]
[-] packages.html [edit]
[-] events.md [edit]
[-] synopsis.html [edit]
[-] inspector.html [edit]
[-] dgram.json [edit]
[-] cli.html [edit]
[-] test.json [edit]
[-] repl.md [edit]
[-] worker_threads.md [edit]
[-] webcrypto.html [edit]
[-] readline.html [edit]
[-] crypto.html [edit]
[-] events.json [edit]
[-] esm.html [edit]
[-] querystring.md [edit]
[-] http.html [edit]
[-] buffer.md [edit]
[-] http2.md [edit]
[-] http.json [edit]
[-] documentation.json [edit]
[-] domain.json [edit]
[-] domain.html [edit]
[-] embedding.md [edit]
[-] cluster.md [edit]
[-] corepack.json [edit]
[-] errors.md [edit]
[-] modules.json [edit]
[-] string_decoder.md [edit]
[-] v8.md [edit]
[-] n-api.html [edit]
[-] module.md [edit]
[-] querystring.json [edit]
[+] ..
[-] querystring.html [edit]
[-] fs.json [edit]
[-] punycode.md [edit]
[-] esm.json [edit]
[-] test.html [edit]
[-] repl.json [edit]
[-] async_hooks.html [edit]
[-] async_hooks.md [edit]
[-] permissions.md [edit]
[-] util.md [edit]
[-] zlib.json [edit]
[-] synopsis.md [edit]
[-] vm.md [edit]
[-] tty.md [edit]
[-] child_process.html [edit]
[-] embedding.html [edit]
[-] stream.html [edit]
[-] report.json [edit]
[-] report.md [edit]
[-] policy.html [edit]
[-] policy.json [edit]
[-] index.md [edit]
[-] addons.html [edit]
[-] worker_threads.html [edit]
[-] path.json [edit]
[-] zlib.md [edit]
[-] buffer.html [edit]
[-] perf_hooks.json [edit]
[-] v8.json [edit]
[-] modules.html [edit]
[-] diagnostics_channel.json [edit]
[-] crypto.json [edit]
[-] corepack.html [edit]
[-] index.html [edit]
[-] os.md [edit]
[-] async_context.html [edit]
[-] readline.json [edit]
[-] async_context.md [edit]
[-] inspector.json [edit]
[-] report.html [edit]
[-] repl.html [edit]
[-] assert.html [edit]
[-] test.md [edit]
[-] packages.json [edit]
[-] perf_hooks.md [edit]
[-] deprecations.md [edit]
[-] intl.json [edit]
[-] webstreams.json [edit]
[-] globals.md [edit]
[-] string_decoder.html [edit]
[-] cluster.html [edit]
[-] perf_hooks.html [edit]
[-] dns.md [edit]
[-] punycode.html [edit]
[-] wasi.json [edit]
[-] n-api.md [edit]
[-] process.html [edit]
[-] dgram.md [edit]
[-] tty.html [edit]
[-] async_hooks.json [edit]
[-] tty.json [edit]
[-] path.md [edit]
[-] dgram.html [edit]
[-] console.json [edit]
[-] intl.html [edit]
[-] tracing.json [edit]
[-] vm.json [edit]
[-] webcrypto.md [edit]
[-] url.html [edit]
[-] console.md [edit]
[-] permissions.json [edit]
[-] synopsis.json [edit]
[-] corepack.md [edit]
[-] embedding.json [edit]
[-] dns.json [edit]
[-] https.md [edit]
[-] documentation.html [edit]
[-] module.json [edit]
[-] process.json [edit]
[-] esm.md [edit]
[-] util.html [edit]
[-] tls.md [edit]
[-] webcrypto.json [edit]
[-] net.json [edit]
[-] http2.json [edit]
[-] cluster.json [edit]
[-] permissions.html [edit]
[-] http2.html [edit]
[-] deprecations.json [edit]
[-] stream.md [edit]
[-] https.json [edit]
[-] url.md [edit]
[-] vm.html [edit]
[-] wasi.md [edit]
[+] assets
[-] diagnostics_channel.html [edit]
[-] stream.json [edit]
[-] all.html [edit]
[-] punycode.json [edit]
[-] url.json [edit]
[-] errors.html [edit]
[-] cli.md [edit]
[-] buffer.json [edit]
[-] worker_threads.json [edit]
[-] globals.html [edit]
[-] string_decoder.json [edit]
[-] console.html [edit]
[-] v8.html [edit]
[-] diagnostics_channel.md [edit]
[-] debugger.json [edit]
[-] child_process.md [edit]
[-] deprecations.html [edit]
[-] os.html [edit]
[-] wasi.html [edit]
[-] domain.md [edit]
[-] os.json [edit]
[-] readline.md [edit]
[-] webstreams.md [edit]
[-] tls.html [edit]
[-] index.json [edit]
[-] intl.md [edit]
[-] tracing.md [edit]
[-] zlib.html [edit]
[-] packages.md [edit]
[-] all.json [edit]
[-] assert.json [edit]
[-] fs.html [edit]
[-] errors.json [edit]
[-] documentation.md [edit]
[-] policy.md [edit]
[-] n-api.json [edit]
[-] timers.html [edit]
[-] cli.json [edit]
[-] modules.md [edit]
[-] http.md [edit]
[-] util.json [edit]
[-] fs.md [edit]
[-] timers.md [edit]
[-] globals.json [edit]
[-] assert.md [edit]
[-] module.html [edit]
[-] dns.html [edit]
[-] net.md [edit]
[-] events.html [edit]
[-] timers.json [edit]
[-] https.html [edit]
[-] crypto.md [edit]
[-] path.html [edit]
[-] addons.md [edit]
[-] net.html [edit]