API Tutorial Demo Install Changes Support GitHub Menu

Edit this page

API class up.Params

The up.Params class offers a consistent API to read and manipulate request parameters independent of their type.

Request parameters are used in form submissions and URLs. Methods like up.submit() or up.replace() accept request parameters as a { params } option.

Supported parameter types

The following types of parameter representation are supported:

An object like { email: 'foo@bar.com' }
A query string like 'email=foo%40bar.com'
An array of { name, value } objects like [{ name: 'email', value: 'foo@bar.com' }]
A FormData object.

Features

All features

JS

new up.Params([params]) stable

Constructs a new up.Params instance.

JS

up.Params.prototype.add(name, value) stable

Adds a new entry with the given name and value.

JS

up.Params.prototype.addAll(params) stable

Adds all entries from the given list of params.

JS

up.Params.prototype.addField(field) experimental

Adds params from the given HTML form field.

JS

up.Params.prototype.clear() stable

Removes all params from this object.

JS

up.Params.prototype.delete(name) stable

Deletes all entries with the given name.

JS

up.Params.prototype.get(name) stable

Returns the first param value with the given name from the given params.

JS

up.Params.prototype.getAll(name) experimental

Returns an array of all param values with the given name.

JS

up.Params.prototype.getFirst(name) experimental

Returns the first param value with the given name.

JS

up.Params.prototype.set(name, value) stable

Sets the value for the entry with given name.

JS

up.Params.prototype.toArray() experimental

Returns an array representation of this up.Params instance.

JS

up.Params.prototype.toFormData() stable

Returns a FormData representation of this up.Params instance.

JS

up.Params.prototype.toObject() experimental

Returns an object representation of this up.Params instance.

JS

up.Params.prototype.toQuery(params) stable

Returns an query string for this up.Params instance.

JS

up.Params.prototype.toURL(base) experimental

Builds an URL string from the given base URL and this up.Params instance as a query string.

JS

up.Params.fromFields(fields) experimental

Constructs a new up.Params instance from one or more HTML form field.

JS

up.Params.fromForm(form) stable

Constructs a new up.Params instance from the given <form>.

JS

up.Params.fromURL(url) stable

Constructs a new up.Params instance from the given URL's query string.

JS

up.Params.stripURL(url) experimental

Returns the given URL without its query string.

Made by Henning Koch

Imprint

Privacy policy