Browse Source

doc refactor: querystring

v0.9.1-release
isaacs 13 years ago
parent
commit
628bc835ae
  1. 12
      doc/api/querystring.markdown

12
doc/api/querystring.markdown

@ -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], [options])
## querystring.parse(str, [sep], [eq], [options])
Deserialize a query string to an object.
Optionally override the default separator (`'&'`) and assignment (`'='`)
@ -34,12 +36,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.

Loading…
Cancel
Save