Class URLSearchParams

Similar to the JavaScript URLSearchParams class, except not an iterator.

Hierarchy

URLSearchParams

Index

Constructors

Methods

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

Constructors

constructor

new URLSearchParams(): URLSearchParams
Returns URLSearchParams

Methods

append

append(key, value): string
Sets the value associated with a given search parameter to the given value.
Parameters
- key: string
- value: string
Returns string
- Defined in B.d.ts:6530

delete

delete(key): string
Deletes the parameter.
Parameters
- key: string
Returns string
- Defined in B.d.ts:6542

entries

entries(): EList<string[]>
Returns an array of [key, value] pairs of the parameters.

Returns EList<string[]>
- Defined in B.d.ts:6547

forEach

forEach(callback): void
Loops over the parameters.
Parameters
- callback: ((value, key?, urlSearchParams?) => void)
  The function to loop with.
  - - (value, key?, urlSearchParams?): void
    - Parameters
      value: string
      Optional key: string
      Optional urlSearchParams: URLSearchParams
      Returns void
Returns void
- Defined in B.d.ts:6574

get

get(key): string
Returns the first value associated with the given search parameter.
Parameters
- key: string
Returns string
- Defined in B.d.ts:6510

getAll

getAll(key): EList<string>
Returns all values associated with the given search parameter.
Parameters
- key: string
Returns EList<string>
- Defined in B.d.ts:6516

has

has(key): boolean
Returns a boolean indicating if the given parameter exists.
Parameters
- key: string
Returns boolean
- Defined in B.d.ts:6536

keys

keys(): EList<string>
Returns an array of the parameters' keys.

Returns EList<string>
- Defined in B.d.ts:6552

set

set(key, value): void
Sets the value associated with a given search parameter to the given value.
Parameters
- key: string
- value: string
Returns void
- Defined in B.d.ts:6523

sort

sort(compareFunction?): void
Internally sorts the parameters.
Parameters
- Optional compareFunction: ((entry1, entry2) => number)
  If omitted, params are sorted by keys.
  - - (entry1, entry2): number
    - Parameters
      entry1: string[]
      entry2: string[]
      Returns number
Returns void
- Defined in B.d.ts:6563

toString

toString(): string
Returns a query string suitable for use in a URL.

Returns string
- Defined in B.d.ts:6568

values

values(): EList<string>
Returns an array of the parameters' values.

Returns EList<string>
- Defined in B.d.ts:6557

Generated using TypeDoc