Blog Post

Download
Query String

querystring.escape(str) :-

(str <string>) The querystring.escape() method performs URL percent-encoding on the given str in a manner that is optimized for the specific requirements of URL query strings.

The querystring.escape() method is used by querystring.stringify() and is generally not expected to be used directly. It is exported primarily to allow application code to provide a replacement percent-encoding implementation if necessary by assigning querystring.escape to an alternative function.

querystring.parse(str[, sep[, eq[, options]]]) :-

• str <string> The URL query string to parse

• sep <string> The substring used to delimit key and value pairs in the query string. Defaults to '&'.

• eq <string>. The substring used to delimit keys and values in the query string. Defaults to '='.

Options :

decodeURIComponent <Function> The function to use when decoding percent-encoded characters in the query string. Defaults toquerystring.unescape().

maxKeys <number> Specifies the maximum number of keys to parse. Defaults to 1000 . Specify 0 to remove key counting limitations.

The querystring.parse() method parses a URL query string (str) into a collection of key and value pairs.

For example,

The query string 'foo=bar&abc=xyz&abc=123' is parsed into:

{ foo: 'bar', abc: ['xyz', '124'] }

querystring.stringify(obj[, sep[, eq[, options]]]) :-

•obj <Object> The object to serialize into a URL query string

•sep <string> The substring used to delimit key and value pairs in the query string. Defaults to '&'.

•eq <string>. The substring used to delimit keys and values in the query string. Defaults to '='.

Options:

encodeURIComponent <Function> The function to use when converting URL-unsafe characters to percent-encoding in the query string. Defaults to querystring.escape().

The querystring.stringify() method produces a URL query string from a given obj by iterating through the object's "own properties".

It serializes the following types of values passed in obj: <string> | <number> | <boolean> | <string[]> | <number[]> | <boolean[]> Any other input values will be coerced to empty strings.

For example:

1. querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });

// returns 'foo=bar&baz=qux&baz=quux&corge='

2.querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':');

// returns 'foo:bar;baz:qux'