doc refactor: querystring

This commit is contained in:
isaacs committed 2012-02-29 16:04:53 -08:00
1 parent e083720d54
commit 798f8a0dc1
1 file changed
+7 -5
+7 -5
View File
@@ -1,9 +1,11 @@
## Query String
# Query String
<!--name=querystring-->
This module provides utilities for dealing with query strings.
It provides the following methods:
### querystring.stringify(obj, [sep], [eq])
## querystring.stringify(obj, [sep], [eq])
Serialize an object to a query string.
Optionally override the default separator (`'&'`) and assignment (`'='`)
@@ -19,7 +21,7 @@ Example:
// returns
'foo:bar;baz:qux'
### querystring.parse(str, [sep], [eq])
## querystring.parse(str, [sep], [eq])
Deserialize a query string to an object.
Optionally override the default separator (`'&'`) and assignment (`'='`)
@@ -31,12 +33,12 @@ Example:
// returns
{ foo: 'bar', baz: ['qux', 'quux'], corge: '' }
### querystring.escape
## querystring.escape
The escape function used by `querystring.stringify`,
provided so that it could be overridden if necessary.
### querystring.unescape
## querystring.unescape
The unescape function used by `querystring.parse`,
provided so that it could be overridden if necessary.