csrc/node-v0.10.24/doc/api/querystring.html - third_party - Git at Google

 <!doctype html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
   <title>Query String Node.js v0.10.24 Manual &amp; Documentation</title>
   <link rel="stylesheet" href="assets/style.css">
   <link rel="stylesheet" href="assets/sh.css">
   <link rel="canonical" href="http://nodejs.org/api/querystring.html">
 </head>
 <body class="alt apidoc" id="api-section-querystring">
     <div id="intro" class="interior">
         <a href="/" title="Go back to the home page">
             <img id="logo" src="http://nodejs.org/images/logo-light.png" alt="node.js">
         </a>
     </div>
     <div id="content" class="clearfix">
         <div id="column2" class="interior">
             <ul>
                 <li><a href="/" class="home">Home</a></li>
                 <li><a href="/download/" class="download">Download</a></li>
                 <li><a href="/about/" class="about">About</a></li>
                 <li><a href="http://npmjs.org/" class="npm">npm Registry</a></li>
                 <li><a href="http://nodejs.org/api/" class="docs current">Docs</a></li>
                 <li><a href="http://blog.nodejs.org" class="blog">Blog</a></li>
                 <li><a href="/community/" class="community">Community</a></li>
                 <li><a href="/logos/" class="logos">Logos</a></li>
                 <li><a href="http://jobs.nodejs.org/" class="jobs">Jobs</a></li>
             </ul>
             <p class="twitter"><a href="http://twitter.com/nodejs">@nodejs</a></p>
         </div>

         <div id="column1" class="interior">
           <header>
             <h1>Node.js v0.10.24 Manual &amp; Documentation</h1>
             <div id="gtoc">
               <p>
                 <a href="index.html" name="toc">Index</a> |
                 <a href="all.html">View on single page</a> |
                 <a href="querystring.json">View as JSON</a>
               </p>
             </div>
             <hr>
           </header>

           <div id="toc">
             <h2>Table of Contents</h2>
             <ul>
 <li><a href="#querystring_query_string">Query String</a><ul>
 <li><a href="#querystring_querystring_stringify_obj_sep_eq">querystring.stringify(obj, [sep], [eq])</a></li>
 <li><a href="#querystring_querystring_parse_str_sep_eq_options">querystring.parse(str, [sep], [eq], [options])</a></li>
 <li><a href="#querystring_querystring_escape">querystring.escape</a></li>
 <li><a href="#querystring_querystring_unescape">querystring.unescape</a></li>
 </ul>
 </li>
 </ul>

           </div>

           <div id="apicontent">
             <h1>Query String<span><a class="mark" href="#querystring_query_string" id="querystring_query_string">#</a></span></h1>
 <pre class="api_stability_3">Stability: 3 - Stable</pre><!--name=querystring-->

 <p>This module provides utilities for dealing with query strings.
 It provides the following methods:

 </p>
 <h2>querystring.stringify(obj, [sep], [eq])<span><a class="mark" href="#querystring_querystring_stringify_obj_sep_eq" id="querystring_querystring_stringify_obj_sep_eq">#</a></span></h2>
 <p>Serialize an object to a query string.
 Optionally override the default separator (<code>&#39;&amp;&#39;</code>) and assignment (<code>&#39;=&#39;</code>)
 characters.

 </p>
 <p>Example:

 </p>
 <pre><code>querystring.stringify({ foo: &#39;bar&#39;, baz: [&#39;qux&#39;, &#39;quux&#39;], corge: &#39;&#39; })
 // returns
 &#39;foo=bar&amp;baz=qux&amp;baz=quux&amp;corge=&#39;

 querystring.stringify({foo: &#39;bar&#39;, baz: &#39;qux&#39;}, &#39;;&#39;, &#39;:&#39;)
 // returns
 &#39;foo:bar;baz:qux&#39;</code></pre>
 <h2>querystring.parse(str, [sep], [eq], [options])<span><a class="mark" href="#querystring_querystring_parse_str_sep_eq_options" id="querystring_querystring_parse_str_sep_eq_options">#</a></span></h2>
 <p>Deserialize a query string to an object.
 Optionally override the default separator (<code>&#39;&amp;&#39;</code>) and assignment (<code>&#39;=&#39;</code>)
 characters.

 </p>
 <p>Options object may contain <code>maxKeys</code> property (equal to 1000 by default), it&#39;ll
 be used to limit processed keys. Set it to 0 to remove key count limitation.

 </p>
 <p>Example:

 </p>
 <pre><code>querystring.parse(&#39;foo=bar&amp;baz=qux&amp;baz=quux&amp;corge&#39;)
 // returns
 { foo: &#39;bar&#39;, baz: [&#39;qux&#39;, &#39;quux&#39;], corge: &#39;&#39; }</code></pre>
 <h2>querystring.escape<span><a class="mark" href="#querystring_querystring_escape" id="querystring_querystring_escape">#</a></span></h2>
 <p>The escape function used by <code>querystring.stringify</code>,
 provided so that it could be overridden if necessary.

 </p>
 <h2>querystring.unescape<span><a class="mark" href="#querystring_querystring_unescape" id="querystring_querystring_unescape">#</a></span></h2>
 <p>The unescape function used by <code>querystring.parse</code>,
 provided so that it could be overridden if necessary.
 </p>

           </div>
         </div>
     </div>
     <div id="footer">
         <a href="http://joyent.com" class="joyent-logo">Joyent</a>
         <ul class="clearfix">
             <li><a href="/">Node.js</a></li>
             <li><a href="/download/">Download</a></li>
             <li><a href="/about/">About</a></li>
             <li><a href="http://npmjs.org/">npm Registry</a></li>
             <li><a href="http://nodejs.org/api/">Docs</a></li>
             <li><a href="http://blog.nodejs.org">Blog</a></li>
             <li><a href="/community/">Community</a></li>
             <li><a href="/logos/">Logos</a></li>
             <li><a href="http://jobs.nodejs.org/">Jobs</a></li>
             <li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li>
         </ul>

         <p>Copyright <a href="http://joyent.com/">Joyent, Inc</a>, Node.js is a <a href="/trademark-policy.pdf">trademark</a> of Joyent, Inc. View <a href="https://raw.github.com/joyent/node/v0.10.24/LICENSE">license</a>.</p>
     </div>

   <script src="../sh_main.js"></script>
   <script src="../sh_javascript.min.js"></script>
   <script>highlight(undefined, undefined, 'pre');</script>
   <script>
     window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']];
     (function(d, t) {
       var g = d.createElement(t),
           s = d.getElementsByTagName(t)[0];
       g.src = '//www.google-analytics.com/ga.js';
       s.parentNode.insertBefore(g, s);
     }(document, 'script'));
   </script>
 </body>
 </html>
	<!doctype html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>Query String Node.js v0.10.24 Manual & Documentation</title>
	<link rel="stylesheet" href="assets/style.css">
	<link rel="stylesheet" href="assets/sh.css">
	<link rel="canonical" href="http://nodejs.org/api/querystring.html">
	</head>
	<body class="alt apidoc" id="api-section-querystring">
	<div id="intro" class="interior">
	<a href="/" title="Go back to the home page">
	<img id="logo" src="http://nodejs.org/images/logo-light.png" alt="node.js">
	</a>
	</div>
	<div id="content" class="clearfix">
	<div id="column2" class="interior">
	<ul>
	<li><a href="/" class="home">Home</a></li>
	<li><a href="/download/" class="download">Download</a></li>
	<li><a href="/about/" class="about">About</a></li>
	<li><a href="http://npmjs.org/" class="npm">npm Registry</a></li>
	<li><a href="http://nodejs.org/api/" class="docs current">Docs</a></li>
	<li><a href="http://blog.nodejs.org" class="blog">Blog</a></li>
	<li><a href="/community/" class="community">Community</a></li>
	<li><a href="/logos/" class="logos">Logos</a></li>
	<li><a href="http://jobs.nodejs.org/" class="jobs">Jobs</a></li>
	</ul>
	<p class="twitter"><a href="http://twitter.com/nodejs">@nodejs</a></p>
	</div>

	<div id="column1" class="interior">
	<header>
	<h1>Node.js v0.10.24 Manual & Documentation</h1>
	<div id="gtoc">
	<p>
	<a href="index.html" name="toc">Index</a> \|
	<a href="all.html">View on single page</a> \|
	<a href="querystring.json">View as JSON</a>
	</p>
	</div>
	<hr>
	</header>

	<div id="toc">
	<h2>Table of Contents</h2>
	<ul>
	<li><a href="#querystring_query_string">Query String</a><ul>
	<li><a href="#querystring_querystring_stringify_obj_sep_eq">querystring.stringify(obj, [sep], [eq])</a></li>
	<li><a href="#querystring_querystring_parse_str_sep_eq_options">querystring.parse(str, [sep], [eq], [options])</a></li>
	<li><a href="#querystring_querystring_escape">querystring.escape</a></li>
	<li><a href="#querystring_querystring_unescape">querystring.unescape</a></li>
	</ul>
	</li>
	</ul>

	</div>

	<div id="apicontent">
	<h1>Query String<span><a class="mark" href="#querystring_query_string" id="querystring_query_string">#</a></span></h1>
	<pre class="api_stability_3">Stability: 3 - Stable</pre><!--name=querystring-->

	<p>This module provides utilities for dealing with query strings.
	It provides the following methods:

	</p>
	<h2>querystring.stringify(obj, [sep], [eq])<span><a class="mark" href="#querystring_querystring_stringify_obj_sep_eq" id="querystring_querystring_stringify_obj_sep_eq">#</a></span></h2>
	<p>Serialize an object to a query string.
	Optionally override the default separator (<code>'&'</code>) and assignment (<code>'='</code>)
	characters.

	</p>
	<p>Example:

	</p>
	<pre><code>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'</code></pre>
	<h2>querystring.parse(str, [sep], [eq], [options])<span><a class="mark" href="#querystring_querystring_parse_str_sep_eq_options" id="querystring_querystring_parse_str_sep_eq_options">#</a></span></h2>
	<p>Deserialize a query string to an object.
	Optionally override the default separator (<code>'&'</code>) and assignment (<code>'='</code>)
	characters.

	</p>
	<p>Options object may contain <code>maxKeys</code> property (equal to 1000 by default), it'll
	be used to limit processed keys. Set it to 0 to remove key count limitation.

	</p>
	<p>Example:

	</p>
	<pre><code>querystring.parse('foo=bar&baz=qux&baz=quux&corge')
	// returns
	{ foo: 'bar', baz: ['qux', 'quux'], corge: '' }</code></pre>
	<h2>querystring.escape<span><a class="mark" href="#querystring_querystring_escape" id="querystring_querystring_escape">#</a></span></h2>
	<p>The escape function used by <code>querystring.stringify</code>,
	provided so that it could be overridden if necessary.

	</p>
	<h2>querystring.unescape<span><a class="mark" href="#querystring_querystring_unescape" id="querystring_querystring_unescape">#</a></span></h2>
	<p>The unescape function used by <code>querystring.parse</code>,
	provided so that it could be overridden if necessary.
	</p>

	</div>
	</div>
	</div>
	<div id="footer">
	<a href="http://joyent.com" class="joyent-logo">Joyent</a>
	<ul class="clearfix">
	<li><a href="/">Node.js</a></li>
	<li><a href="/download/">Download</a></li>
	<li><a href="/about/">About</a></li>
	<li><a href="http://npmjs.org/">npm Registry</a></li>
	<li><a href="http://nodejs.org/api/">Docs</a></li>
	<li><a href="http://blog.nodejs.org">Blog</a></li>
	<li><a href="/community/">Community</a></li>
	<li><a href="/logos/">Logos</a></li>
	<li><a href="http://jobs.nodejs.org/">Jobs</a></li>
	<li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li>
	</ul>

	<p>Copyright <a href="http://joyent.com/">Joyent, Inc</a>, Node.js is a <a href="/trademark-policy.pdf">trademark</a> of Joyent, Inc. View <a href="https://raw.github.com/joyent/node/v0.10.24/LICENSE">license</a>.</p>
	</div>

	<script src="../sh_main.js"></script>
	<script src="../sh_javascript.min.js"></script>
	<script>highlight(undefined, undefined, 'pre');</script>
	<script>
	window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']];
	(function(d, t) {
	var g = d.createElement(t),
	s = d.getElementsByTagName(t)[0];
	g.src = '//www.google-analytics.com/ga.js';
	s.parentNode.insertBefore(g, s);
	}(document, 'script'));
	</script>
	</body>
	</html>