Interface URLSearchParams

Hierarchy

URLSearchParams

Index

Methods

[iterator] append delete entries forEach get getAll has keys set sort toString values

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
- name: string
- value: string
Returns void

delete

delete(name): void
Deletes the given search parameter, and its associated value, from the list of all search parameters.

MDN Reference
Parameters
- name: string
Returns void

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
- callbackfn: ((value, key, parent) => void)
  - - (value, key, parent): void
    - Parameters
      
      value: string
      
      key: string
      
      parent: URLSearchParams
      
      Returns void
- Optional thisArg: any
Returns void

get

get(name): string
Returns the first value associated to the given search parameter.

MDN Reference
Parameters
- name: string
Returns string

getAll

getAll(name): string[]
Returns all the values association with a given search parameter.

MDN Reference
Parameters
- name: string
Returns string[]

has

has(name): boolean
Returns a Boolean indicating if such a search parameter exists.

MDN Reference
Parameters
- name: string
Returns boolean

keys

keys(): IterableIterator<string>
Returns a list of keys in the search params.

Returns IterableIterator<string>

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.

MDN Reference
Parameters
- name: string
- value: string
Returns void

sort

sort(): void
MDN Reference

Returns void

toString

toString(): string
Returns a string containing a query string suitable for use in a URL. Does not include the question mark.

Returns string

values

values(): IterableIterator<string>
Returns a list of values in the search params.

Returns IterableIterator<string>