Browse Source

doc: sort querystring alphabetically

Reorders, with no contextual changes, the querystring documentation
alphabetically.

PR-URL: https://github.com/nodejs/node/pull/3662
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
v5.x
Tristian Flanagan 9 years ago
committed by Rod Vagg
parent
commit
d357b3090e
  1. 54
      doc/api/querystring.markdown

54
doc/api/querystring.markdown

@ -7,31 +7,10 @@
This module provides utilities for dealing with query strings.
It provides the following methods:
## querystring.stringify(obj[, sep][, eq][, options])
Serialize an object to a query string.
Optionally override the default separator (`'&'`) and assignment (`'='`)
characters.
Options object may contain `encodeURIComponent` property (`querystring.escape` by default),
it can be used to encode string with `non-utf8` encoding if necessary.
Example:
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'
## querystring.escape
// Suppose gbkEncodeURIComponent function already exists,
// it can encode string with `gbk` encoding
querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
{ encodeURIComponent: gbkEncodeURIComponent })
// returns
'w=%D6%D0%CE%C4&foo=bar'
The escape function used by `querystring.stringify`,
provided so that it could be overridden if necessary.
## querystring.parse(str[, sep][, eq][, options])
@ -58,10 +37,31 @@ Example:
// returns
{ w: '中文', foo: 'bar' }
## querystring.escape
## querystring.stringify(obj[, sep][, eq][, options])
The escape function used by `querystring.stringify`,
provided so that it could be overridden if necessary.
Serialize an object to a query string.
Optionally override the default separator (`'&'`) and assignment (`'='`)
characters.
Options object may contain `encodeURIComponent` property (`querystring.escape` by default),
it can be used to encode string with `non-utf8` encoding if necessary.
Example:
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'
// Suppose gbkEncodeURIComponent function already exists,
// it can encode string with `gbk` encoding
querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
{ encodeURIComponent: gbkEncodeURIComponent })
// returns
'w=%D6%D0%CE%C4&foo=bar'
## querystring.unescape

Loading…
Cancel
Save