2010-10-28 14:18:16 +02:00
|
|
|
## Query String
|
|
|
|
|
2010-11-18 13:00:24 +01:00
|
|
|
This module provides utilities for dealing with query strings.
|
|
|
|
It provides the following methods:
|
2010-10-28 14:18:16 +02:00
|
|
|
|
|
|
|
### querystring.stringify(obj, sep='&', eq='=')
|
|
|
|
|
2010-11-18 13:00:24 +01:00
|
|
|
Serialize an object to a query string.
|
|
|
|
Optionally override the default separator and assignment characters.
|
2010-10-28 14:18:16 +02:00
|
|
|
|
|
|
|
Example:
|
|
|
|
|
2011-08-30 00:21:37 +02:00
|
|
|
querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })
|
2010-10-28 14:18:16 +02:00
|
|
|
// returns
|
2011-08-30 00:21:37 +02:00
|
|
|
'foo=bar&baz=qux&baz=quux&corge='
|
2010-10-28 14:18:16 +02:00
|
|
|
|
2011-08-30 00:21:37 +02:00
|
|
|
querystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')
|
2010-10-28 14:18:16 +02:00
|
|
|
// returns
|
2011-08-30 00:21:37 +02:00
|
|
|
'foo:bar;baz:qux'
|
2010-10-28 14:18:16 +02:00
|
|
|
|
|
|
|
### querystring.parse(str, sep='&', eq='=')
|
|
|
|
|
2010-11-18 13:00:24 +01:00
|
|
|
Deserialize a query string to an object.
|
|
|
|
Optionally override the default separator and assignment characters.
|
2010-10-28 14:18:16 +02:00
|
|
|
|
|
|
|
Example:
|
|
|
|
|
2011-08-30 00:21:37 +02:00
|
|
|
querystring.parse('foo=bar&baz=qux&baz=quux&corge')
|
2010-10-28 14:18:16 +02:00
|
|
|
// returns
|
2011-08-30 00:21:37 +02:00
|
|
|
{ foo: 'bar', baz: ['qux', 'quux'], corge: '' }
|
2010-10-28 14:18:16 +02:00
|
|
|
|
|
|
|
### querystring.escape
|
|
|
|
|
2010-11-18 13:00:24 +01:00
|
|
|
The escape function used by `querystring.stringify`,
|
|
|
|
provided so that it could be overridden if necessary.
|
2010-10-28 14:18:16 +02:00
|
|
|
|
|
|
|
### querystring.unescape
|
|
|
|
|
2010-11-18 13:00:24 +01:00
|
|
|
The unescape function used by `querystring.parse`,
|
|
|
|
provided so that it could be overridden if necessary.
|