up.Params - Unpoly

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.

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. On IE 11 and Edge, FormData payloads require a polyfill for FormData#entries().

All features

new up.Params([params]) experimental

Constructs a new up.Params instance.

up.Params#add(name, value) experimental

Adds a new entry with the given name and value.

up.Params#addAll(params) experimental

Adds all entries from the given list of params.

up.Params#addField(field) experimental

Adds params from the given HTML form field.

up.Params#clear() experimental

Removes all params from this object.

up.Params#delete(name) experimental

Deletes all entries with the given name.

up.Params.fromFields(fields) experimental

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

up.Params.fromForm(form) experimental

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

up.Params.fromURL(url) experimental

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

up.Params#get(name) experimental

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

up.Params#set(name, value) experimental

Sets the value for the entry with given name.

up.Params.stripURL(url) experimental

Returns the given URL without its query string.

up.Params#toArray() experimental

Returns an array representation of this up.Params instance.

up.Params#toFormData() experimental

Returns a FormData representation of this up.Params instance.

up.Params#toObject() experimental

Returns an object representation of this up.Params instance.

up.Params#toQuery(params) experimental

Returns an query string for this up.Params instance.

up.Params#toURL(base) experimental

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

API class up.Params