Interface URLSearchParams

Readonlysize

[iterator]

• "[iterator]"(): URLSearchParamsIterator<[string, string]>

  Returns URLSearchParamsIterator<[string, string]>

append

• append(name: string, value: string): void

  The append() method of the URLSearchParams interface appends a specified key/value pair as a new search parameter.

  MDN Reference

  Parameters

  • name: string
  • value: string

  Returns void

delete

• delete(name: string, value?: string): void

  The delete() method of the URLSearchParams interface deletes specified parameters and their associated value(s) from the list of all search parameters.

  MDN Reference

  Parameters

  • name: string
  • Optionalvalue: string

  Returns void

entries

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

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

  Returns URLSearchParamsIterator<[string, string]>

forEach

• forEach(
      callbackfn: (
          value: string,
          key: string,
          parent: URLSearchParams,
      ) => void,
      thisArg?: any,
  ): void

  Parameters

  • callbackfn: (value: string, key: string, parent: URLSearchParams) => void
  • OptionalthisArg: any

  Returns void

get

• get(name: string): string | null

  The get() method of the URLSearchParams interface returns the first value associated to the given search parameter.

  MDN Reference

  Parameters

  • name: string

  Returns string | null

getAll

• getAll(name: string): string[]

  The getAll() method of the URLSearchParams interface returns all the values associated with a given search parameter as an array.

  MDN Reference

  Parameters

  • name: string

  Returns string[]

has

• has(name: string, value?: string): boolean

  The has() method of the URLSearchParams interface returns a boolean value that indicates whether the specified parameter is in the search parameters.

  MDN Reference

  Parameters

  • name: string
  • Optionalvalue: string

  Returns boolean

keys

• keys(): URLSearchParamsIterator<string>

  Returns a list of keys in the search params.

  Returns URLSearchParamsIterator<string>

set

• set(name: string, value: string): void

  The set() method of the URLSearchParams interface sets 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.

  MDN Reference

  Parameters

  • name: string
  • value: string

  Returns void

sort

• sort(): void

  The URLSearchParams.sort() method sorts all key/value pairs contained in this object in place and returns undefined. Key/value pairs are sorted by the values of the UTF-16 code units 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).

  MDN Reference

  Returns void

toString

• toString(): string

  Returns string

values

• values(): URLSearchParamsIterator<string>

  Returns a list of values in the search params.

  Returns URLSearchParamsIterator<string>