The querystring module provides utilities for parsing and formatting URL\nquery strings. It can be accessed using:
const querystring = require('querystring');\nThe querystring.decode() function is an alias for querystring.parse().
The querystring.encode() function is an alias for querystring.stringify().
str <string>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.
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.
str <string> The URL query string to parsesep <string> The substring used to delimit key and value pairs in the\nquery string. Default: '&'.eq <string>. The substring used to delimit keys and values in the\nquery string. Default: '='.options <Object>
decodeURIComponent <Function> The function to use when decoding\npercent-encoded characters in the query string. Default:\nquerystring.unescape().maxKeys <number> Specifies the maximum number of keys to parse.\nSpecify 0 to remove key counting limitations. Default: 1000.The querystring.parse() method parses a URL query string (str) into a\ncollection of key and value pairs.
For example, the query string 'foo=bar&abc=xyz&abc=123' is parsed into:
{\n foo: 'bar',\n abc: ['xyz', '123']\n}\nThe object returned by the querystring.parse() method does not\nprototypically inherit from the JavaScript Object. This means that typical\nObject methods such as obj.toString(), obj.hasOwnProperty(), and others\nare not defined and will not work.
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:
// Assuming gbkDecodeURIComponent function already exists...\n\nquerystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,\n { decodeURIComponent: gbkDecodeURIComponent });\nobj <Object> The object to serialize into a URL query stringsep <string> The substring used to delimit key and value pairs in the\nquery string. Default: '&'.eq <string>. The substring used to delimit keys and values in the\nquery string. Default: '='.options
encodeURIComponent <Function> The function to use when converting\nURL-unsafe characters to percent-encoding in the query string. Default:\nquerystring.escape().The querystring.stringify() method produces a URL query string from a\ngiven obj by iterating through the object's \"own properties\".
It serializes the following types of values passed in obj:\n<string> | <number> | <boolean> | <string[]> | <number[]> | <boolean[]>\nAny other input values will be coerced to empty strings.
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'\nBy 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:
// Assuming gbkEncodeURIComponent function already exists,\n\nquerystring.stringify({ w: '中文', foo: 'bar' }, null, null,\n { encodeURIComponent: gbkEncodeURIComponent });\nstr <string>The querystring.unescape() method performs decoding of URL percent-encoded\ncharacters on the given str.
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.
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.