{"source":"doc/api/querystring.md","modules":[{"textRaw":"Query String","name":"querystring","stability": 2,"stabilityText":"Stable","desc":"

The querystring module provides utilities for parsing and formatting URL\nquery strings. It can be accessed using:

\n
const querystring = require('querystring');\n
\n","methods":[{"textRaw":"querystring.escape(str)","type":"method","name":"escape","meta":{"added":["v0.1.25"]},"signatures":[{"params":[{"textRaw":"`str`{String}","name":"str","type":"String"}]},{"params":[{"name":"str"}]}],"desc":"

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

\n

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

\n"},{"textRaw":"querystring.parse(str[, sep[, eq[, options]]])","type":"method","name":"parse","meta":{"added":["v0.1.25"]},"signatures":[{"params":[{"textRaw":"`str`{String}The URL query string to parse ","name":"str","type":"String","desc":"The URL query string to parse"},{"textRaw":"`sep`{String}The substring used to delimit key and value pairs in the query string. Defaults to `'&'`. ","name":"sep","type":"String","desc":"The substring used to delimit key and value pairs in the query string. Defaults to `'&'`.","optional": true},{"textRaw":"`eq`{String}. The substring used to delimit keys and values in the query string. Defaults to `'='`. ","name":"eq","type":"String","desc":". The substring used to delimit keys and values in the query string. Defaults to `'='`.","optional": true},{"textRaw":"`options`{Object}","options":[{"textRaw":"`decodeURIComponent`{Function}The function to use when decoding percent-encoded characters in the query string. Defaults to `querystring.unescape()`. ","name":"decodeURIComponent","type":"Function","desc":"The function to use when decoding percent-encoded characters in the query string. Defaults to `querystring.unescape()`."},{"textRaw":"`maxKeys`{number}Specifies the maximum number of keys to parse. Defaults to `1000`. Specify `0` to remove key counting limitations. ","name":"maxKeys","type":"number","desc":"Specifies the maximum number of keys to parse. Defaults to `1000`. Specify `0` to remove key counting limitations."}],"name":"options","type":"Object","optional": true}]},{"params":[{"name":"str"},{"name":"sep","optional": true},{"name":"eq","optional": true},{"name":"options","optional": true}]}],"desc":"

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

\n

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

\n
{\n  foo: 'bar',\n  abc:['xyz', '123']\n}\n
\n

Note: The object returned by the querystring.parse() method does not\nprototypically extend from the JavaScript Object. This means that the\ntypical Object methods such as obj.toString(), obj.hashOwnProperty(),\nand others are not defined and will not work.

\n

By default, percent-encoded characters within the query string will be assumed\nto use UTF-8 encoding. If an alternative character encoding is used, then an\nalternative decodeURIComponent option will need to be specified as illustrated\nin the following example:

\n
// Assuming gbkDecodeURIComponent function already exists...\n\nquerystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,\n{decodeURIComponent: gbkDecodeURIComponent})\n
\n"},{"textRaw":"querystring.stringify(obj[, sep[, eq[, options]]])","type":"method","name":"stringify","meta":{"added":["v0.1.25"]},"signatures":[{"params":[{"textRaw":"`obj`{Object}The object to serialize into a URL query string ","name":"obj","type":"Object","desc":"The object to serialize into a URL query string"},{"textRaw":"`sep`{String}The substring used to delimit key and value pairs in the query string. Defaults to `'&'`. ","name":"sep","type":"String","desc":"The substring used to delimit key and value pairs in the query string. Defaults to `'&'`.","optional": true},{"textRaw":"`eq`{String}. The substring used to delimit keys and values in the query string. Defaults to `'='`. ","name":"eq","type":"String","desc":". The substring used to delimit keys and values in the query string. Defaults to `'='`.","optional": true},{"textRaw":"`options` ","options":[{"textRaw":"`encodeURIComponent`{Function}The function to use when converting URL-unsafe characters to percent-encoding in the query string. Defaults to `querystring.escape()`. ","name":"encodeURIComponent","type":"Function","desc":"The function to use when converting URL-unsafe characters to percent-encoding in the query string. Defaults to `querystring.escape()`."}],"name":"options","optional": true}]},{"params":[{"name":"obj"},{"name":"sep","optional": true},{"name":"eq","optional": true},{"name":"options","optional": true}]}],"desc":"

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

\n

For example:

\n
querystring.stringify({foo: 'bar', baz:['qux', 'quux'], corge: ''})\n// returns 'foo=bar&baz=qux&baz=quux&corge='\n\nquerystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')\n// returns 'foo:bar;baz:qux'\n
\n

By default, characters requiring percent-encoding within the query string will\nbe encoded as UTF-8. If an alternative encoding is required, then an alternative\nencodeURIComponent option will need to be specified as illustrated in the\nfollowing example:

\n
// Assuming gbkEncodeURIComponent function already exists,\n\nquerystring.stringify({w: '中文', foo: 'bar'}, null, null,\n{encodeURIComponent: gbkEncodeURIComponent})\n
\n"},{"textRaw":"querystring.unescape(str)","type":"method","name":"unescape","meta":{"added":["v0.1.25"]},"signatures":[{"params":[{"textRaw":"`str`{String}","name":"str","type":"String"}]},{"params":[{"name":"str"}]}],"desc":"

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

\n

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

\n

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

\n"}],"type":"module","displayName":"querystring"}]}