Properties Jump to heading
Jump to headingsize: numberContains the number of search parameters
searchParams.size
Methods Jump to heading
Jump to headingappend(name: string,value: string,): voidAppends a specified key/value pair as a new search parameter.
let searchParams = new URLSearchParams();
searchParams.append('name', 'first');
searchParams.append('name', 'second');
Jump to headingdelete(name: string,value?: string,): voidDeletes search parameters that match a name, and optional value, from the list of all search parameters.
let searchParams = new URLSearchParams([['name', 'value']]);
searchParams.delete('name');
searchParams.delete('name', 'value');
Jump to headinggetAll(name: string): string[]Returns all the values associated with a given search parameter as an array.
searchParams.getAll('name');
Jump to headingget(name: string): string | nullReturns the first value associated to the given search parameter.
searchParams.get('name');
Jump to headinghas(name: string,value?: string,): booleanReturns a boolean value indicating if a given parameter, or parameter and value pair, exists.
searchParams.has('name');
searchParams.has('name', 'value');
Jump to headingset(name: string,value: string,): voidSets the value associated with a given search parameter to the given value. If there were several matching values, this method deletes the others. If the search parameter doesn't exist, this method creates it.
searchParams.set('name', 'value');
Jump to headingsort(): voidSort all key/value pairs contained in this object in place and return undefined. The sort order is according to Unicode code points of the keys.
searchParams.sort();
Jump to headingforEach(callbackfn: (value: string,key: string,parent: this,) => void,thisArg?: any,): voidCalls a function for each element contained in this object in place and return undefined. Optionally accepts an object to use as this when executing callback as second argument.
const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
params.forEach((value, key, parent) => {
console.log(value, key, parent);
});
Jump to headingkeys(): IterableIterator<string>Returns an iterator allowing to go through all keys contained in this object.
const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const key of params.keys()) {
console.log(key);
}
Jump to headingvalues(): IterableIterator<string>Returns an iterator allowing to go through all values contained in this object.
const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const value of params.values()) {
console.log(value);
}
Jump to headingentries(): IterableIterator<[string, string]>Returns an iterator allowing to go through all key/value pairs contained in this object.
const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const [key, value] of params.entries()) {
console.log(key, value);
}
Jump to heading[[Symbol.iterator]](): IterableIterator<[string, string]>Returns an iterator allowing to go through all key/value pairs contained in this object.
const params = new URLSearchParams([["a", "b"], ["c", "d"]]);
for (const [key, value] of params) {
console.log(key, value);
}
Jump to headingtoString(): stringReturns a query string suitable for use in a URL.
searchParams.toString();