View source

class URLSearchParams

package js.html

@:native("URLSearchParams")

Available on js

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

Documentation URLSearchParams by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Constructor

new(?init:Array<Array<String>>)

new(?init:DynamicAccess<String>)

@:value({ init : "" })new(init:String = "")

Throws:

null

DOMError

Methods

append(name:String, value:String):Void

Appends a specified key/value pair as a new search parameter.

delete(name:String):Void

Deletes the given search parameter, and its associated value, from the list of all search parameters.

entries():URLSearchParamsIterator

Returns an Iteration_protocols allowing to go through all key/value pairs contained in this object.

Throws:

null

DOMError

forEach(callback:Dynamic, ?thisArg:Dynamic):Void

Throws:

null

DOMError

get(name:String):String

Returns the first value associated to the given search parameter.

getAll(name:String):Array<String>

Returns all the values associated with a given search parameter.

has(name:String):Bool

Returns a Boolean indicating if such a search parameter exists.

keys():URLSearchParamsIterator

Returns an Iteration_protocols allowing to go through all keys of the key/value pairs contained in this object.

Throws:

null

DOMError

set(name:String, value:String):Void

Sets the value associated to a given search parameter to the given value. If there were several values, delete the others.

sort():Void

Sorts all key/value pairs, if any, by their keys.

Throws:

null

DOMError

values():URLSearchParamsIterator

Returns an Iteration_protocols allowing to go through all values of the key/value pairs contained in this object.

Throws:

null

DOMError