URLSearchParams

new URLSearchParams(init?): URLSearchParams

Parameters

Parameter	Type
`init`?	`string` \| `URLSearchParams` \| `Record`<`string`, `string`> \| `string`[][]

Properties

Property	Modifier	Type	Description
`size`	`readonly`	`number`	MDN Reference

Methods

[iterator]()

[iterator](): IterableIterator<[string, string]>

Returns

IterableIterator<[string, string]>

append()

append(name, value): void

Appends a specified key/value pair as a new search parameter.

MDN Reference

Parameters

Parameter	Type
`name`	`string`
`value`	`string`

delete()

delete(name, value?): void

Deletes the given search parameter, and its associated value, from the list of all search parameters.

MDN Reference

Parameters

Parameter	Type
`name`	`string`
`value`?	`string`

entries()

entries(): IterableIterator<[string, string]>

Returns an array of key, value pairs for every entry in the search params.

Returns

IterableIterator<[string, string]>

forEach()

forEach(callbackfn, thisArg): void

Parameters

Parameter	Type
`callbackfn`	(`value`, `key`, `parent`) => `void`
`thisArg`	`any`

get()

get(name): null | string

Returns the first value associated to the given search parameter.

MDN Reference

Parameters

Parameter	Type
`name`	`string`

getAll()

getAll(name): string[]

Returns all the values association with a given search parameter.

MDN Reference

Parameters

Parameter	Type
`name`	`string`

has()

has(name): boolean

Returns a Boolean indicating if such a search parameter exists.

MDN Reference

Parameters

Parameter	Type
`name`	`string`

keys()

keys(): IterableIterator<string>

Returns a list of keys in the search params.

set()

set(name, value): void

Sets the value associated to a given search parameter to the given value. If there were several values, delete the others.

Parameters

Parameter	Type
`name`	`string`
`value`	`string`

See

https://developer.mozilla.org/docs/Web/API/URLSearchParams/set

Sorts all key/value pairs contained in this object in place and returns undefined. The sort order is according to unicode code points of the keys. This method uses a stable sorting algorithm (i.e. the relative order between key/value pairs with equal keys will be preserved).

const params = new URLSearchParams({ foo: '1', bar: '2' });
 
// Add a second foo parameter.
params.append("foo", 4);
 
params.toString();
// Returns "foo=1&bar=2&foo=4"

URLSearchParams

On this page