URLSearchParams: toString() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is available in Web Workers.
The toString()
method of the
URLSearchParams
interface returns a query string suitable for use in a
URL.
Note:
This method returns the query string without the question mark. This is different from Location.search
, HTMLAnchorElement.search
, and URL.search
, which all include the question mark.
Syntax
toString()
Parameters
None.
Return value
A string, without the question mark. Returns an empty string if no search parameters have been set. Characters in the application/x-www-form-urlencoded
percent-encode set (which contains all code points except ASCII alphanumeric, *
, -
, .
, and _
) are percent-encoded, and U+0020 SPACE is encoded as +
.
Examples
const url = new URL("https://example.com?foo=1&bar=2");
const params = new URLSearchParams(url.search);
// Add a second foo parameter.
params.append("foo", 4);
console.log(params.toString()); // Prints 'foo=1&bar=2&foo=4'
Specifications
Specification |
---|
URL # urlsearchparams-stringification-behavior |
Browser compatibility
BCD tables only load in the browser
See also
- The
URL
interface. - Google Developers: Easy URL manipulation with URLSearchParams