kotlin-web/web.url/URLSearchParams

URLSearchParams

open class URLSearchParams(init: ReadonlyArray<Tuple2<JsString, JsString>> = definedExternally) : ReadonlyMap.Mixin<JsString, JsString> , BodyInit(source)

The URLSearchParams interface defines utility methods to work with the query string of a URL.

MDN Reference

Constructors

URLSearchParams

constructor(init: ReadonlyArray<Tuple2<JsString, JsString>> = definedExternally)

constructor(init: ReadonlyRecord<JsString, JsString>)

constructor(init: String)

constructor(init: URLSearchParams)

Properties

size

open external override val size: Int

The size read-only property of the URLSearchParams interface indicates the total number of search parameter entries.

Functions

append

external fun append(key: String, value: String)

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

delete

external fun delete(key: String, value: String = definedExternally)

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

entries

open external fun entries(): JsIterator<Tuple2<JsString, JsString>>

forEach

open external fun forEach(action: (JsString, JsString) -> Unit)

get

open external override fun get(key: JsString): JsString?

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

getAll

external fun getAll(key: String): ReadonlyArray<JsString>

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

has

open external fun has(key: JsString): Boolean

external fun has(key: String, value: String): Boolean

open external override fun has(key: JsString): Boolean

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

keys

open external override fun keys(): JsIterator<JsString>

set

external fun set(key: String, value: String)

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.

sort

external fun sort()

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).

values

open external fun values(): JsIterator<JsString>