Skip to main content

stringify

function stringify
Jump to headingstringify(
sep?: string,
eq?: string,
options?: StringifyOptions,
): string

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 | bigint | boolean | string[] | number[] | bigint[] | boolean[] The numeric values must be finite. Any other input values will be coerced to empty strings.

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'

By default, characters requiring percent-encoding within the query string will be encoded as UTF-8. If an alternative encoding is required, then an alternative encodeURIComponent option will need to be specified:

// Assuming gbkEncodeURIComponent function already exists,

querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
                      { encodeURIComponent: gbkEncodeURIComponent });

Parameters Jump to heading

The object to serialize into a URL query string

optional
Jump to headingsep: string = '&'

The substring used to delimit key and value pairs in the query string.

optional
Jump to headingeq: string = '='

. The substring used to delimit keys and values in the query string.

Return Type Jump to heading

string
Back to top