API reference `up.Params`
class

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

new up.Params([params]) JS

Constructs a new up.Params instance.
up.Params.prototype.add(name, value) JS

Adds a new entry with the given name and value.
up.Params.prototype.addAll(params) JS

Adds all entries from the given list of params.
up.Params.prototype.addField(field, [options]) JS experimental

Adds params from the given HTML form field.
up.Params.prototype.clear() JS

Removes all params from this object.
up.Params.prototype.delete(name) JS

Deletes all entries with the given name.
up.Params.prototype.get(name) JS

Returns the first param value with the given name.
up.Params.prototype.getAll(name) JS experimental

Returns an array of all param values with the given name.
up.Params.prototype.getFirst(name) JS experimental

Returns the first param value with the given name.
up.Params.prototype.set(name, value) JS

Sets the value for the entry with given name.
up.Params.prototype.toArray() JS experimental

Returns an array representation of this up.Params instance.
up.Params.prototype.toFormData() JS

Returns a FormData representation of this up.Params instance.
up.Params.prototype.toObject() JS experimental

Returns an object representation of this up.Params instance.
up.Params.prototype.toQuery() JS

Returns a query string for this up.Params instance.
up.Params.prototype.toURL(base) JS experimental

Builds a URL string from the given base URL and this up.Params instance as a query string.
up.Params.fromContainer(container, [options]) JS experimental

Constructs a new up.Params instance from the fields within the given container.
up.Params.fromFields(fields) JS experimental

Constructs a new up.Params instance from one or more HTML form fields.
up.Params.fromForm(form, [options]) JS

Constructs a new up.Params instance from the given <form>.
up.Params.fromURL(url) JS

Constructs a new up.Params instance from the given URL's query string.
up.Params.stripURL(url) JS experimental

Returns the given URL without its query string.

API reference up.Params class

Supported parameter types

Features

API reference `up.Params`
class