doc/api/querystring.markdown

   1 ## Query String
   2
   3 This module provides utilities for dealing with query strings.
   4 It provides the following methods:
   5
   6 ### querystring.stringify(obj, sep='&', eq='=')
   7
   8 Serialize an object to a query string.
   9 Optionally override the default separator and assignment characters.
  10
  11 Example:
  12
  13     querystring.stringify({foo: 'bar'})
  14     // returns
  15     'foo=bar'
  16
  17     querystring.stringify({foo: 'bar', baz: 'bob'}, ';', ':')
  18     // returns
  19     'foo:bar;baz:bob'
  20
  21 ### querystring.parse(str, sep='&', eq='=')
  22
  23 Deserialize a query string to an object.
  24 Optionally override the default separator and assignment characters.
  25
  26 Example:
  27
  28     querystring.parse('a=b&b=c')
  29     // returns
  30     { a: 'b', b: 'c' }
  31
  32 ### querystring.escape
  33
  34 The escape function used by `querystring.stringify`,
  35 provided so that it could be overridden if necessary.
  36
  37 ### querystring.unescape
  38
  39 The unescape function used by `querystring.parse`,
  40 provided so that it could be overridden if necessary.