Class Params

constructor

• new Params(init?): Params

• Parameters

  • Optional init: string | URLSearchParams | Record<string, string | readonly string[]> | readonly [string, string][] | Iterable<[string, string]>

  Returns Params

Readonly size

[iterator]

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

• Returns IterableIterator<[string, string]>

append

• append(name, value): void

• Append a new name-value pair to the query string.

  Parameters

  • name: string

  • value: string

  Returns void

delete

• delete(name, value?): void

• If value is provided, removes all name-value pairs where name is name and value is value..

  If value is not provided, removes all name-value pairs whose name is name.

  Parameters

  • name: string

  • Optional value: string

  Returns void

entries

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

• Returns an ES6 Iterator over each of the name-value pairs in the query. Each item of the iterator is a JavaScript Array. The first item of the Arrayis the name, the second item of the Array is the value.

  Alias for urlSearchParams[@@iterator]().

  Returns IterableIterator<[string, string]>

forEach

• forEach<TThis>(callback, thisArg?): void

• Iterates over each name-value pair in the query and invokes the given function.

  const myURL = new URL('https://example.org/?a=b&c=d');
  myURL.searchParams.forEach((value, name, searchParams) => {
    console.log(name, value, myURL.searchParams === searchParams);
  });
  // Prints:
  //   a b true
  //   c d true
  Copy

  Type Parameters

  • TThis = Params

  Parameters

  • callback: ((this, value, name, searchParams) => void)

    • • (this, value, name, searchParams): void

      • Parameters

        • this: TThis

        • value: string

        • name: string

        • searchParams: URLSearchParams

        Returns void

  • Optional thisArg: TThis

    To be used as this value for when fn is called

  Returns void

get

• get(name): null | string

• Returns the value of the first name-value pair whose name is name. If there are no such pairs, null is returned.

  Parameters

  • name: string

  Returns null | string

  or null if there is no name-value pair with the given name.

getAll

• getAll(name): string[]

• Returns the values of all name-value pairs whose name is name. If there are no such pairs, an empty array is returned.

  Parameters

  • name: string

  Returns string[]

has

• has(name, value?): boolean

• Checks if the URLSearchParams object contains key-value pair(s) based onname and an optional value argument.

  If value is provided, returns true when name-value pair with same name and value exists.

  If value is not provided, returns true if there is at least one name-value pair whose name is name.

  Parameters

  • name: string

  • Optional value: string

  Returns boolean

keys

• keys(): IterableIterator<string>

• Returns an ES6 Iterator over the names of each name-value pair.

  const params = new URLSearchParams('foo=bar&foo=baz');
  for (const name of params.keys()) {
    console.log(name);
  }
  // Prints:
  //   foo
  //   foo
  Copy

  Returns IterableIterator<string>

set

• set(name, value): void

• Sets the value in the URLSearchParams object associated with name tovalue. If there are any pre-existing name-value pairs whose names are name, set the first such pair's value to value and remove all others. If not, append the name-value pair to the query string.

  const params = new URLSearchParams();
  params.append('foo', 'bar');
  params.append('foo', 'baz');
  params.append('abc', 'def');
  console.log(params.toString());
  // Prints foo=bar&foo=baz&abc=def
  
  params.set('foo', 'def');
  params.set('xyz', 'opq');
  console.log(params.toString());
  // Prints foo=def&abc=def&xyz=opq
  Copy

  Parameters

  • name: string

  • value: string

  Returns void

sort

• sort(): void

• Sort all existing name-value pairs in-place by their names. Sorting is done with a stable sorting algorithm, so relative order between name-value pairs with the same name is preserved.

  This method can be used, in particular, to increase cache hits.

  const params = new URLSearchParams('query[]=abc&type=search&query[]=123');
  params.sort();
  console.log(params.toString());
  // Prints query%5B%5D=abc&query%5B%5D=123&type=search
  Copy

  Returns void

  Since

  v7.7.0, v6.13.0

toString

• toString(): string

• Returns the search parameters serialized as a string, with characters percent-encoded where necessary.

  Returns string

values

• values(): IterableIterator<string>

• Returns an ES6 Iterator over the values of each name-value pair.

  Returns IterableIterator<string>