Skip to content

URLSearchParams

Values

append

Appends a specified key/value pair as a new search parameter. Read more on MDN

let append: (
WebAPI.FetchAPI.urlSearchParams,
~name: string,
~value: string,
) => unit

Parameters

WebAPI.FetchAPI.urlSearchParams string string

Return type

unit

delete

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

let delete: (
WebAPI.FetchAPI.urlSearchParams,
~name: string,
~value: string=?,
) => unit

Parameters

WebAPI.FetchAPI.urlSearchParams string option< string >

Return type

unit

entries

Returns key/value pairs in the same order as they appear in the query string. Read more on MDN

let entries: WebAPI.FetchAPI.urlSearchParams => Iterator.t<
(string, string),
>

Parameters

WebAPI.FetchAPI.urlSearchParams

Return type

Stdlib.Iterator.t

fromDict

let fromDict: dict<string> => WebAPI.FetchAPI.urlSearchParams

Parameters

dict< string >

Return type

WebAPI.FetchAPI.urlSearchParams

fromKeyValueArray

let fromKeyValueArray: array<(string, string)> => WebAPI.FetchAPI.urlSearchParams

Parameters

array

Return type

WebAPI.FetchAPI.urlSearchParams

fromString

let fromString: string => WebAPI.FetchAPI.urlSearchParams

Parameters

string

Return type

WebAPI.FetchAPI.urlSearchParams

get

Returns the first value associated to the given search parameter. Read more on MDN

let get: (WebAPI.FetchAPI.urlSearchParams, string) => string

Parameters

WebAPI.FetchAPI.urlSearchParams string

Return type

string

getAll

Returns all the values association with a given search parameter. Read more on MDN

let getAll: (WebAPI.FetchAPI.urlSearchParams, string) => array<string>

Parameters

WebAPI.FetchAPI.urlSearchParams string

Return type

array< string >

has

Returns a Boolean indicating if such a search parameter exists. Read more on MDN

let has: (
WebAPI.FetchAPI.urlSearchParams,
~name: string,
~value: string=?,
) => bool

Parameters

WebAPI.FetchAPI.urlSearchParams string option< string >

Return type

bool

keys

Returns an iterator allowing iteration through all keys contained in this object. Read more on MDN

let keys: WebAPI.FetchAPI.urlSearchParams => Iterator.t<string>

Parameters

WebAPI.FetchAPI.urlSearchParams

Return type

Stdlib.Iterator.t< string >

make

let make: unit => WebAPI.FetchAPI.urlSearchParams

Parameters

unit

Return type

WebAPI.FetchAPI.urlSearchParams

set

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

let set: (
WebAPI.FetchAPI.urlSearchParams,
~name: string,
~value: string,
) => unit

Parameters

WebAPI.FetchAPI.urlSearchParams string string

Return type

unit

sort

let sort: WebAPI.FetchAPI.urlSearchParams => unit

Parameters

WebAPI.FetchAPI.urlSearchParams

Return type

unit

toString

Returns the query string suitable for use in a URL, without the question mark. Read more on MDN

let toString: WebAPI.FetchAPI.urlSearchParams => string

Parameters

WebAPI.FetchAPI.urlSearchParams

Return type

string

values

Returns an iterator allowing iteration through all values contained in this object. Read more on MDN

let values: WebAPI.FetchAPI.urlSearchParams => Iterator.t<string>

Parameters

WebAPI.FetchAPI.urlSearchParams

Return type

Stdlib.Iterator.t< string >