11cb0ef41Sopenharmony_ci<!DOCTYPE html> 21cb0ef41Sopenharmony_ci<html lang="en"> 31cb0ef41Sopenharmony_ci<head> 41cb0ef41Sopenharmony_ci <meta charset="utf-8"> 51cb0ef41Sopenharmony_ci <meta name="viewport" content="width=device-width"> 61cb0ef41Sopenharmony_ci <meta name="nodejs.org:node-version" content="v18.20.1"> 71cb0ef41Sopenharmony_ci <title>Query string | Node.js v18.20.1 Documentation</title> 81cb0ef41Sopenharmony_ci <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 91cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/style.css"> 101cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/hljs.css"> 111cb0ef41Sopenharmony_ci <link rel="canonical" href="https://nodejs.org/api/querystring.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-querystring"> 161cb0ef41Sopenharmony_ci <div id="content" class="clearfix"> 171cb0ef41Sopenharmony_ci <div id="column2" class="interior"> 181cb0ef41Sopenharmony_ci <div id="intro" class="interior"> 191cb0ef41Sopenharmony_ci <a href="/" title="Go back to the home page"> 201cb0ef41Sopenharmony_ci Node.js 211cb0ef41Sopenharmony_ci </a> 221cb0ef41Sopenharmony_ci </div> 231cb0ef41Sopenharmony_ci <ul> 241cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 261cb0ef41Sopenharmony_ci</ul> 271cb0ef41Sopenharmony_ci<hr class="line"> 281cb0ef41Sopenharmony_ci<ul> 291cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 301cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 311cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 321cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 331cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 341cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 351cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 361cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 371cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 391cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 401cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 411cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 421cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 431cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 441cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 451cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 461cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 471cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 481cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 491cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 501cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 511cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 521cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 531cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 541cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 551cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 561cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 571cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 581cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 591cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 601cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 611cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 621cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 631cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 641cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 651cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 661cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 671cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring active">Query strings</a></li> 681cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 691cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 701cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 711cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 721cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 731cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 741cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 751cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 761cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 771cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 781cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 791cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 801cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 811cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 821cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 831cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 841cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 851cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 861cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 871cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 881cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 891cb0ef41Sopenharmony_ci</ul> 901cb0ef41Sopenharmony_ci<hr class="line"> 911cb0ef41Sopenharmony_ci<ul> 921cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 931cb0ef41Sopenharmony_ci</ul> 941cb0ef41Sopenharmony_ci </div> 951cb0ef41Sopenharmony_ci 961cb0ef41Sopenharmony_ci <div id="column1" data-id="querystring" class="interior"> 971cb0ef41Sopenharmony_ci <header class="header"> 981cb0ef41Sopenharmony_ci <div class="header-container"> 991cb0ef41Sopenharmony_ci <h1>Node.js v18.20.1 documentation</h1> 1001cb0ef41Sopenharmony_ci <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 1011cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 1021cb0ef41Sopenharmony_ci <path fill="none" d="M0 0h24v24H0z" /> 1031cb0ef41Sopenharmony_ci <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 1041cb0ef41Sopenharmony_ci <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 1051cb0ef41Sopenharmony_ci </svg> 1061cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 1071cb0ef41Sopenharmony_ci <path d="M0 0h24v24H0z" fill="none" /> 1081cb0ef41Sopenharmony_ci <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 1091cb0ef41Sopenharmony_ci </svg> 1101cb0ef41Sopenharmony_ci </button> 1111cb0ef41Sopenharmony_ci </div> 1121cb0ef41Sopenharmony_ci <div id="gtoc"> 1131cb0ef41Sopenharmony_ci <ul> 1141cb0ef41Sopenharmony_ci <li class="pinned-header">Node.js v18.20.1</li> 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_ci <li class="picker-header"> 1171cb0ef41Sopenharmony_ci <a href="#"> 1181cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1191cb0ef41Sopenharmony_ci Table of contents 1201cb0ef41Sopenharmony_ci </a> 1211cb0ef41Sopenharmony_ci 1221cb0ef41Sopenharmony_ci <div class="picker"><div class="toc"><ul> 1231cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#query-string">Query string</a></span> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#querystringdecode"><code>querystring.decode()</code></a></li> 1261cb0ef41Sopenharmony_ci<li><a href="#querystringencode"><code>querystring.encode()</code></a></li> 1271cb0ef41Sopenharmony_ci<li><a href="#querystringescapestr"><code>querystring.escape(str)</code></a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#querystringparsestr-sep-eq-options"><code>querystring.parse(str[, sep[, eq[, options]]])</code></a></li> 1291cb0ef41Sopenharmony_ci<li><a href="#querystringstringifyobj-sep-eq-options"><code>querystring.stringify(obj[, sep[, eq[, options]]])</code></a></li> 1301cb0ef41Sopenharmony_ci<li><a href="#querystringunescapestr"><code>querystring.unescape(str)</code></a></li> 1311cb0ef41Sopenharmony_ci</ul> 1321cb0ef41Sopenharmony_ci</li> 1331cb0ef41Sopenharmony_ci</ul></div></div> 1341cb0ef41Sopenharmony_ci </li> 1351cb0ef41Sopenharmony_ci 1361cb0ef41Sopenharmony_ci 1371cb0ef41Sopenharmony_ci <li class="picker-header"> 1381cb0ef41Sopenharmony_ci <a href="#"> 1391cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1401cb0ef41Sopenharmony_ci Index 1411cb0ef41Sopenharmony_ci </a> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci <div class="picker"><ul> 1441cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1451cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1461cb0ef41Sopenharmony_ci 1471cb0ef41Sopenharmony_ci <li> 1481cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1491cb0ef41Sopenharmony_ci </li> 1501cb0ef41Sopenharmony_ci </ul> 1511cb0ef41Sopenharmony_ci 1521cb0ef41Sopenharmony_ci<hr class="line"> 1531cb0ef41Sopenharmony_ci<ul> 1541cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1551cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1561cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1571cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1581cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1591cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1601cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1611cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1621cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1631cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1641cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1651cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1661cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1671cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1681cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1701cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1711cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring active">Query strings</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2141cb0ef41Sopenharmony_ci</ul> 2151cb0ef41Sopenharmony_ci<hr class="line"> 2161cb0ef41Sopenharmony_ci<ul> 2171cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2181cb0ef41Sopenharmony_ci</ul></div> 2191cb0ef41Sopenharmony_ci </li> 2201cb0ef41Sopenharmony_ci 2211cb0ef41Sopenharmony_ci 2221cb0ef41Sopenharmony_ci <li class="picker-header"> 2231cb0ef41Sopenharmony_ci <a href="#"> 2241cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2251cb0ef41Sopenharmony_ci Other versions 2261cb0ef41Sopenharmony_ci </a> 2271cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/querystring.html">21.x</a></li> 2281cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/querystring.html">20.x <b>LTS</b></a></li> 2291cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/querystring.html">19.x</a></li> 2301cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/querystring.html">18.x <b>LTS</b></a></li> 2311cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/querystring.html">17.x</a></li> 2321cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/querystring.html">16.x</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/querystring.html">15.x</a></li> 2341cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/querystring.html">14.x</a></li> 2351cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/querystring.html">13.x</a></li> 2361cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/querystring.html">12.x</a></li> 2371cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/querystring.html">11.x</a></li> 2381cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/querystring.html">10.x</a></li> 2391cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/querystring.html">9.x</a></li> 2401cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/querystring.html">8.x</a></li> 2411cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/querystring.html">7.x</a></li> 2421cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/querystring.html">6.x</a></li> 2431cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/querystring.html">5.x</a></li> 2441cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/querystring.html">4.x</a></li> 2451cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/querystring.html">0.12.x</a></li> 2461cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/querystring.html">0.10.x</a></li></ol></div> 2471cb0ef41Sopenharmony_ci </li> 2481cb0ef41Sopenharmony_ci 2491cb0ef41Sopenharmony_ci <li class="picker-header"> 2501cb0ef41Sopenharmony_ci <a href="#"> 2511cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2521cb0ef41Sopenharmony_ci Options 2531cb0ef41Sopenharmony_ci </a> 2541cb0ef41Sopenharmony_ci 2551cb0ef41Sopenharmony_ci <div class="picker"> 2561cb0ef41Sopenharmony_ci <ul> 2571cb0ef41Sopenharmony_ci <li> 2581cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2591cb0ef41Sopenharmony_ci </li> 2601cb0ef41Sopenharmony_ci <li> 2611cb0ef41Sopenharmony_ci <a href="querystring.json">View as JSON</a> 2621cb0ef41Sopenharmony_ci </li> 2631cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/querystring.md">Edit on GitHub</a></li> 2641cb0ef41Sopenharmony_ci </ul> 2651cb0ef41Sopenharmony_ci </div> 2661cb0ef41Sopenharmony_ci </li> 2671cb0ef41Sopenharmony_ci </ul> 2681cb0ef41Sopenharmony_ci </div> 2691cb0ef41Sopenharmony_ci <hr> 2701cb0ef41Sopenharmony_ci </header> 2711cb0ef41Sopenharmony_ci 2721cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2731cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#query-string">Query string</a></span> 2741cb0ef41Sopenharmony_ci<ul> 2751cb0ef41Sopenharmony_ci<li><a href="#querystringdecode"><code>querystring.decode()</code></a></li> 2761cb0ef41Sopenharmony_ci<li><a href="#querystringencode"><code>querystring.encode()</code></a></li> 2771cb0ef41Sopenharmony_ci<li><a href="#querystringescapestr"><code>querystring.escape(str)</code></a></li> 2781cb0ef41Sopenharmony_ci<li><a href="#querystringparsestr-sep-eq-options"><code>querystring.parse(str[, sep[, eq[, options]]])</code></a></li> 2791cb0ef41Sopenharmony_ci<li><a href="#querystringstringifyobj-sep-eq-options"><code>querystring.stringify(obj[, sep[, eq[, options]]])</code></a></li> 2801cb0ef41Sopenharmony_ci<li><a href="#querystringunescapestr"><code>querystring.unescape(str)</code></a></li> 2811cb0ef41Sopenharmony_ci</ul> 2821cb0ef41Sopenharmony_ci</li> 2831cb0ef41Sopenharmony_ci</ul></details> 2841cb0ef41Sopenharmony_ci 2851cb0ef41Sopenharmony_ci <div id="apicontent"> 2861cb0ef41Sopenharmony_ci <h2>Query string<span><a class="mark" href="#query-string" id="query-string">#</a></span><a aria-hidden="true" class="legacy" id="querystring_query_string"></a></h2> 2871cb0ef41Sopenharmony_ci 2881cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 2891cb0ef41Sopenharmony_ci 2901cb0ef41Sopenharmony_ci<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/querystring.js">lib/querystring.js</a></p> 2911cb0ef41Sopenharmony_ci<p>The <code>node:querystring</code> module provides utilities for parsing and formatting URL 2921cb0ef41Sopenharmony_ciquery strings. It can be accessed using:</p> 2931cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> querystring = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:querystring'</span>);</code> <button class="copy-button">copy</button></pre> 2941cb0ef41Sopenharmony_ci<p><code>querystring</code> is more performant than <a href="url.html#class-urlsearchparams" class="type"><URLSearchParams></a> but is not a 2951cb0ef41Sopenharmony_cistandardized API. Use <a href="url.html#class-urlsearchparams" class="type"><URLSearchParams></a> when performance is not critical or 2961cb0ef41Sopenharmony_ciwhen compatibility with browser code is desirable.</p> 2971cb0ef41Sopenharmony_ci<section><h3><code>querystring.decode()</code><span><a class="mark" href="#querystringdecode" id="querystringdecode">#</a></span><a aria-hidden="true" class="legacy" id="querystring_querystring_decode"></a></h3> 2981cb0ef41Sopenharmony_ci<div class="api_metadata"> 2991cb0ef41Sopenharmony_ci<span>Added in: v0.1.99</span> 3001cb0ef41Sopenharmony_ci</div> 3011cb0ef41Sopenharmony_ci<p>The <code>querystring.decode()</code> function is an alias for <code>querystring.parse()</code>.</p> 3021cb0ef41Sopenharmony_ci</section><section><h3><code>querystring.encode()</code><span><a class="mark" href="#querystringencode" id="querystringencode">#</a></span><a aria-hidden="true" class="legacy" id="querystring_querystring_encode"></a></h3> 3031cb0ef41Sopenharmony_ci<div class="api_metadata"> 3041cb0ef41Sopenharmony_ci<span>Added in: v0.1.99</span> 3051cb0ef41Sopenharmony_ci</div> 3061cb0ef41Sopenharmony_ci<p>The <code>querystring.encode()</code> function is an alias for <code>querystring.stringify()</code>.</p> 3071cb0ef41Sopenharmony_ci</section><section><h3><code>querystring.escape(str)</code><span><a class="mark" href="#querystringescapestr" id="querystringescapestr">#</a></span><a aria-hidden="true" class="legacy" id="querystring_querystring_escape_str"></a></h3> 3081cb0ef41Sopenharmony_ci<div class="api_metadata"> 3091cb0ef41Sopenharmony_ci<span>Added in: v0.1.25</span> 3101cb0ef41Sopenharmony_ci</div> 3111cb0ef41Sopenharmony_ci<ul> 3121cb0ef41Sopenharmony_ci<li><code>str</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3131cb0ef41Sopenharmony_ci</ul> 3141cb0ef41Sopenharmony_ci<p>The <code>querystring.escape()</code> method performs URL percent-encoding on the given 3151cb0ef41Sopenharmony_ci<code>str</code> in a manner that is optimized for the specific requirements of URL 3161cb0ef41Sopenharmony_ciquery strings.</p> 3171cb0ef41Sopenharmony_ci<p>The <code>querystring.escape()</code> method is used by <code>querystring.stringify()</code> and is 3181cb0ef41Sopenharmony_cigenerally not expected to be used directly. It is exported primarily to allow 3191cb0ef41Sopenharmony_ciapplication code to provide a replacement percent-encoding implementation if 3201cb0ef41Sopenharmony_cinecessary by assigning <code>querystring.escape</code> to an alternative function.</p> 3211cb0ef41Sopenharmony_ci</section><section><h3><code>querystring.parse(str[, sep[, eq[, options]]])</code><span><a class="mark" href="#querystringparsestr-sep-eq-options" id="querystringparsestr-sep-eq-options">#</a></span><a aria-hidden="true" class="legacy" id="querystring_querystring_parse_str_sep_eq_options"></a></h3> 3221cb0ef41Sopenharmony_ci<div class="api_metadata"> 3231cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 3241cb0ef41Sopenharmony_ci<table> 3251cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 3261cb0ef41Sopenharmony_ci<tr><td>v8.0.0</td> 3271cb0ef41Sopenharmony_ci<td><p>Multiple empty entries are now parsed correctly (e.g. <code>&=&=</code>).</p></td></tr> 3281cb0ef41Sopenharmony_ci<tr><td>v6.0.0</td> 3291cb0ef41Sopenharmony_ci<td><p>The returned object no longer inherits from <code>Object.prototype</code>.</p></td></tr> 3301cb0ef41Sopenharmony_ci<tr><td>v6.0.0, v4.2.4</td> 3311cb0ef41Sopenharmony_ci<td><p>The <code>eq</code> parameter may now have a length of more than <code>1</code>.</p></td></tr> 3321cb0ef41Sopenharmony_ci<tr><td>v0.1.25</td> 3331cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.1.25</span></p></td></tr> 3341cb0ef41Sopenharmony_ci</tbody></table> 3351cb0ef41Sopenharmony_ci</details> 3361cb0ef41Sopenharmony_ci</div> 3371cb0ef41Sopenharmony_ci<ul> 3381cb0ef41Sopenharmony_ci<li><code>str</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The URL query string to parse</li> 3391cb0ef41Sopenharmony_ci<li><code>sep</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The substring used to delimit key and value pairs in the 3401cb0ef41Sopenharmony_ciquery string. <strong>Default:</strong> <code>'&'</code>.</li> 3411cb0ef41Sopenharmony_ci<li><code>eq</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a>. The substring used to delimit keys and values in the 3421cb0ef41Sopenharmony_ciquery string. <strong>Default:</strong> <code>'='</code>.</li> 3431cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 3441cb0ef41Sopenharmony_ci<ul> 3451cb0ef41Sopenharmony_ci<li><code>decodeURIComponent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The function to use when decoding 3461cb0ef41Sopenharmony_cipercent-encoded characters in the query string. <strong>Default:</strong> 3471cb0ef41Sopenharmony_ci<code>querystring.unescape()</code>.</li> 3481cb0ef41Sopenharmony_ci<li><code>maxKeys</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the maximum number of keys to parse. 3491cb0ef41Sopenharmony_ciSpecify <code>0</code> to remove key counting limitations. <strong>Default:</strong> <code>1000</code>.</li> 3501cb0ef41Sopenharmony_ci</ul> 3511cb0ef41Sopenharmony_ci</li> 3521cb0ef41Sopenharmony_ci</ul> 3531cb0ef41Sopenharmony_ci<p>The <code>querystring.parse()</code> method parses a URL query string (<code>str</code>) into a 3541cb0ef41Sopenharmony_cicollection of key and value pairs.</p> 3551cb0ef41Sopenharmony_ci<p>For example, the query string <code>'foo=bar&abc=xyz&abc=123'</code> is parsed into:</p> 3561cb0ef41Sopenharmony_ci<!-- eslint-skip --> 3571cb0ef41Sopenharmony_ci<pre><code class="language-js">{ 3581cb0ef41Sopenharmony_ci <span class="hljs-attr">foo</span>: <span class="hljs-string">'bar'</span>, 3591cb0ef41Sopenharmony_ci <span class="hljs-attr">abc</span>: [<span class="hljs-string">'xyz'</span>, <span class="hljs-string">'123'</span>] 3601cb0ef41Sopenharmony_ci}</code> <button class="copy-button">copy</button></pre> 3611cb0ef41Sopenharmony_ci<p>The object returned by the <code>querystring.parse()</code> method <em>does not</em> 3621cb0ef41Sopenharmony_ciprototypically inherit from the JavaScript <code>Object</code>. This means that typical 3631cb0ef41Sopenharmony_ci<code>Object</code> methods such as <code>obj.toString()</code>, <code>obj.hasOwnProperty()</code>, and others 3641cb0ef41Sopenharmony_ciare not defined and <em>will not work</em>.</p> 3651cb0ef41Sopenharmony_ci<p>By default, percent-encoded characters within the query string will be assumed 3661cb0ef41Sopenharmony_cito use UTF-8 encoding. If an alternative character encoding is used, then an 3671cb0ef41Sopenharmony_cialternative <code>decodeURIComponent</code> option will need to be specified:</p> 3681cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-comment">// Assuming gbkDecodeURIComponent function already exists...</span> 3691cb0ef41Sopenharmony_ci 3701cb0ef41Sopenharmony_ciquerystring.<span class="hljs-title function_">parse</span>(<span class="hljs-string">'w=%D6%D0%CE%C4&foo=bar'</span>, <span class="hljs-literal">null</span>, <span class="hljs-literal">null</span>, 3711cb0ef41Sopenharmony_ci { <span class="hljs-attr">decodeURIComponent</span>: gbkDecodeURIComponent });</code> <button class="copy-button">copy</button></pre> 3721cb0ef41Sopenharmony_ci</section><section><h3><code>querystring.stringify(obj[, sep[, eq[, options]]])</code><span><a class="mark" href="#querystringstringifyobj-sep-eq-options" id="querystringstringifyobj-sep-eq-options">#</a></span><a aria-hidden="true" class="legacy" id="querystring_querystring_stringify_obj_sep_eq_options"></a></h3> 3731cb0ef41Sopenharmony_ci<div class="api_metadata"> 3741cb0ef41Sopenharmony_ci<span>Added in: v0.1.25</span> 3751cb0ef41Sopenharmony_ci</div> 3761cb0ef41Sopenharmony_ci<ul> 3771cb0ef41Sopenharmony_ci<li><code>obj</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> The object to serialize into a URL query string</li> 3781cb0ef41Sopenharmony_ci<li><code>sep</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The substring used to delimit key and value pairs in the 3791cb0ef41Sopenharmony_ciquery string. <strong>Default:</strong> <code>'&'</code>.</li> 3801cb0ef41Sopenharmony_ci<li><code>eq</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a>. The substring used to delimit keys and values in the 3811cb0ef41Sopenharmony_ciquery string. <strong>Default:</strong> <code>'='</code>.</li> 3821cb0ef41Sopenharmony_ci<li><code>options</code> 3831cb0ef41Sopenharmony_ci<ul> 3841cb0ef41Sopenharmony_ci<li><code>encodeURIComponent</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The function to use when converting 3851cb0ef41Sopenharmony_ciURL-unsafe characters to percent-encoding in the query string. <strong>Default:</strong> 3861cb0ef41Sopenharmony_ci<code>querystring.escape()</code>.</li> 3871cb0ef41Sopenharmony_ci</ul> 3881cb0ef41Sopenharmony_ci</li> 3891cb0ef41Sopenharmony_ci</ul> 3901cb0ef41Sopenharmony_ci<p>The <code>querystring.stringify()</code> method produces a URL query string from a 3911cb0ef41Sopenharmony_cigiven <code>obj</code> by iterating through the object's "own properties".</p> 3921cb0ef41Sopenharmony_ci<p>It serializes the following types of values passed in <code>obj</code>: 3931cb0ef41Sopenharmony_ci<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/Reference/Global_Objects/BigInt" class="type"><bigint></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/Reference/Global_Objects/BigInt" class="type"><bigint[]></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean[]></a> 3941cb0ef41Sopenharmony_ciThe numeric values must be finite. Any other input values will be coerced to 3951cb0ef41Sopenharmony_ciempty strings.</p> 3961cb0ef41Sopenharmony_ci<pre><code class="language-js">querystring.<span class="hljs-title function_">stringify</span>({ <span class="hljs-attr">foo</span>: <span class="hljs-string">'bar'</span>, <span class="hljs-attr">baz</span>: [<span class="hljs-string">'qux'</span>, <span class="hljs-string">'quux'</span>], <span class="hljs-attr">corge</span>: <span class="hljs-string">''</span> }); 3971cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns 'foo=bar&baz=qux&baz=quux&corge='</span> 3981cb0ef41Sopenharmony_ci 3991cb0ef41Sopenharmony_ciquerystring.<span class="hljs-title function_">stringify</span>({ <span class="hljs-attr">foo</span>: <span class="hljs-string">'bar'</span>, <span class="hljs-attr">baz</span>: <span class="hljs-string">'qux'</span> }, <span class="hljs-string">';'</span>, <span class="hljs-string">':'</span>); 4001cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns 'foo:bar;baz:qux'</span></code> <button class="copy-button">copy</button></pre> 4011cb0ef41Sopenharmony_ci<p>By default, characters requiring percent-encoding within the query string will 4021cb0ef41Sopenharmony_cibe encoded as UTF-8. If an alternative encoding is required, then an alternative 4031cb0ef41Sopenharmony_ci<code>encodeURIComponent</code> option will need to be specified:</p> 4041cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-comment">// Assuming gbkEncodeURIComponent function already exists,</span> 4051cb0ef41Sopenharmony_ci 4061cb0ef41Sopenharmony_ciquerystring.<span class="hljs-title function_">stringify</span>({ <span class="hljs-attr">w</span>: <span class="hljs-string">'中文'</span>, <span class="hljs-attr">foo</span>: <span class="hljs-string">'bar'</span> }, <span class="hljs-literal">null</span>, <span class="hljs-literal">null</span>, 4071cb0ef41Sopenharmony_ci { <span class="hljs-attr">encodeURIComponent</span>: gbkEncodeURIComponent });</code> <button class="copy-button">copy</button></pre> 4081cb0ef41Sopenharmony_ci</section><section><h3><code>querystring.unescape(str)</code><span><a class="mark" href="#querystringunescapestr" id="querystringunescapestr">#</a></span><a aria-hidden="true" class="legacy" id="querystring_querystring_unescape_str"></a></h3> 4091cb0ef41Sopenharmony_ci<div class="api_metadata"> 4101cb0ef41Sopenharmony_ci<span>Added in: v0.1.25</span> 4111cb0ef41Sopenharmony_ci</div> 4121cb0ef41Sopenharmony_ci<ul> 4131cb0ef41Sopenharmony_ci<li><code>str</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4141cb0ef41Sopenharmony_ci</ul> 4151cb0ef41Sopenharmony_ci<p>The <code>querystring.unescape()</code> method performs decoding of URL percent-encoded 4161cb0ef41Sopenharmony_cicharacters on the given <code>str</code>.</p> 4171cb0ef41Sopenharmony_ci<p>The <code>querystring.unescape()</code> method is used by <code>querystring.parse()</code> and is 4181cb0ef41Sopenharmony_cigenerally not expected to be used directly. It is exported primarily to allow 4191cb0ef41Sopenharmony_ciapplication code to provide a replacement decoding implementation if 4201cb0ef41Sopenharmony_cinecessary by assigning <code>querystring.unescape</code> to an alternative function.</p> 4211cb0ef41Sopenharmony_ci<p>By default, the <code>querystring.unescape()</code> method will attempt to use the 4221cb0ef41Sopenharmony_ciJavaScript built-in <code>decodeURIComponent()</code> method to decode. If that fails, 4231cb0ef41Sopenharmony_cia safer equivalent that does not throw on malformed URLs will be used.</p></section> 4241cb0ef41Sopenharmony_ci <!-- API END --> 4251cb0ef41Sopenharmony_ci </div> 4261cb0ef41Sopenharmony_ci </div> 4271cb0ef41Sopenharmony_ci </div> 4281cb0ef41Sopenharmony_ci</body> 4291cb0ef41Sopenharmony_ci</html> 430