{
"type": "module",
"source": "doc/api/querystring.md",
"modules": [
{
"textRaw": "Query String",
"name": "querystring",
"introduced_in": "v0.10.0",
"stability": 2,
"stabilityText": "Stable",
"desc": "<p>The <code>querystring</code> module provides utilities for parsing and formatting URL\nquery strings. It can be accessed using:</p>\n<pre><code class=\"language-js\">const querystring = require('querystring');\n</code></pre>",
"methods": [
{
"textRaw": "querystring.decode()",
"type": "method",
"name": "decode",
"meta": {
"added": [
"v0.1.99"
],
"changes": []
},
"signatures": [
{
"params": []
}
],
"desc": "<p>The <code>querystring.decode()</code> function is an alias for <code>querystring.parse()</code>.</p>"
},
{
"textRaw": "querystring.encode()",
"type": "method",
"name": "encode",
"meta": {
"added": [
"v0.1.99"
],
"changes": []
},
"signatures": [
{
"params": []
}
],
"desc": "<p>The <code>querystring.encode()</code> function is an alias for <code>querystring.stringify()</code>.</p>"
},
{
"textRaw": "querystring.escape(str)",
"type": "method",
"name": "escape",
"meta": {
"added": [
"v0.1.25"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`str` {string}",
"name": "str",
"type": "string"
}
]
}
],
"desc": "<p>The <code>querystring.escape()</code> method performs URL percent-encoding on the given\n<code>str</code> in a manner that is optimized for the specific requirements of URL\nquery strings.</p>\n<p>The <code>querystring.escape()</code> method is used by <code>querystring.stringify()</code> 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 <code>querystring.escape</code> to an alternative function.</p>"
},
{
"textRaw": "querystring.parse(str[, sep[, eq[, options]]])",
"type": "method",
"name": "parse",
"meta": {
"added": [
"v0.1.25"
],
"changes": [
{
"version": "v8.0.0",
"pr-url": "https://github.com/nodejs/node/pull/10967",
"description": "Multiple empty entries are now parsed correctly (e.g. `&=&=`)."
},
{
"version": "v6.0.0",
"pr-url": "https://github.com/nodejs/node/pull/6055",
"description": "The returned object no longer inherits from `Object.prototype`."
},
{
"version": "v6.0.0, v4.2.4",
"pr-url": "https://github.com/nodejs/node/pull/3807",
"description": "The `eq` parameter may now have a length of more than `1`."
}
]
},
"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. **Default:** `'&'`.",
"name": "sep",
"type": "string",
"default": "`'&'`",
"desc": "The substring used to delimit key and value pairs in the query string.",
"optional": true
},
{
"textRaw": "`eq` {string}. The substring used to delimit keys and values in the query string. **Default:** `'='`.",
"name": "eq",
"type": "string",
"default": "`'='`",
"desc": ". The substring used to delimit keys and values in the query string.",
"optional": true
},
{
"textRaw": "`options` {Object}",
"name": "options",
"type": "Object",
"options": [
{
"textRaw": "`decodeURIComponent` {Function} The function to use when decoding percent-encoded characters in the query string. **Default:** `querystring.unescape()`.",
"name": "decodeURIComponent",
"type": "Function",
"default": "`querystring.unescape()`",
"desc": "The function to use when decoding percent-encoded characters in the query string."
},
{
"textRaw": "`maxKeys` {number} Specifies the maximum number of keys to parse. Specify `0` to remove key counting limitations. **Default:** `1000`.",
"name": "maxKeys",
"type": "number",
"default": "`1000`",
"desc": "Specifies the maximum number of keys to parse. Specify `0` to remove key counting limitations."
}
],
"optional": true
}
]
}
],
"desc": "<p>The <code>querystring.parse()</code> method parses a URL query string (<code>str</code>) into a\ncollection of key and value pairs.</p>\n<p>For example, the query string <code>'foo=bar&abc=xyz&abc=123'</code> is parsed into:</p>\n<!-- eslint-skip -->\n<pre><code class=\"language-js\">{\n foo: 'bar',\n abc: ['xyz', '123']\n}\n</code></pre>\n<p>The object returned by the <code>querystring.parse()</code> method <em>does not</em>\nprototypically inherit from the JavaScript <code>Object</code>. This means that typical\n<code>Object</code> methods such as <code>obj.toString()</code>, <code>obj.hasOwnProperty()</code>, and others\nare not defined and <em>will not work</em>.</p>\n<p>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 <code>decodeURIComponent</code> option will need to be specified:</p>\n<pre><code class=\"language-js\">// Assuming gbkDecodeURIComponent function already exists...\n\nquerystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,\n { decodeURIComponent: gbkDecodeURIComponent });\n</code></pre>"
},
{
"textRaw": "querystring.stringify(obj[, sep[, eq[, options]]])",
"type": "method",
"name": "stringify",
"meta": {
"added": [
"v0.1.25"
],
"changes": []
},
"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. **Default:** `'&'`.",
"name": "sep",
"type": "string",
"default": "`'&'`",
"desc": "The substring used to delimit key and value pairs in the query string.",
"optional": true
},
{
"textRaw": "`eq` {string}. The substring used to delimit keys and values in the query string. **Default:** `'='`.",
"name": "eq",
"type": "string",
"default": "`'='`",
"desc": ". The substring used to delimit keys and values in the query string.",
"optional": true
},
{
"textRaw": "`options`",
"name": "options",
"options": [
{
"textRaw": "`encodeURIComponent` {Function} The function to use when converting URL-unsafe characters to percent-encoding in the query string. **Default:** `querystring.escape()`.",
"name": "encodeURIComponent",
"type": "Function",
"default": "`querystring.escape()`",
"desc": "The function to use when converting URL-unsafe characters to percent-encoding in the query string."
}
],
"optional": true
}
]
}
],
"desc": "<p>The <code>querystring.stringify()</code> method produces a URL query string from a\ngiven <code>obj</code> by iterating through the object's \"own properties\".</p>\n<p>It serializes the following types of values passed in <code>obj</code>:\n<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><number></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" class=\"type\"><boolean></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type\" class=\"type\"><string[]></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type\" class=\"type\"><number[]></a> | <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type\" class=\"type\"><boolean[]></a>\nAny other input values will be coerced to empty strings.</p>\n<pre><code class=\"language-js\">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</code></pre>\n<p>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\n<code>encodeURIComponent</code> option will need to be specified:</p>\n<pre><code class=\"language-js\">// Assuming gbkEncodeURIComponent function already exists,\n\nquerystring.stringify({ w: 'ä¸æ', foo: 'bar' }, null, null,\n { encodeURIComponent: gbkEncodeURIComponent });\n</code></pre>"
},
{
"textRaw": "querystring.unescape(str)",
"type": "method",
"name": "unescape",
"meta": {
"added": [
"v0.1.25"
],
"changes": []
},
"signatures": [
{
"params": [
{
"textRaw": "`str` {string}",
"name": "str",
"type": "string"
}
]
}
],
"desc": "<p>The <code>querystring.unescape()</code> method performs decoding of URL percent-encoded\ncharacters on the given <code>str</code>.</p>\n<p>The <code>querystring.unescape()</code> method is used by <code>querystring.parse()</code> 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 <code>querystring.unescape</code> to an alternative function.</p>\n<p>By default, the <code>querystring.unescape()</code> method will attempt to use the\nJavaScript built-in <code>decodeURIComponent()</code> method to decode. If that fails,\na safer equivalent that does not throw on malformed URLs will be used.</p>"
}
],
"type": "module",
"displayName": "querystring"
}
]
}
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
3838a972c94b8bbe6fb04220e63b7ff2
>
files
>
115
