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.
On IE 11 and Edge,
FormDatapayloads require a polyfill forFormData#entries().
All features
JSConstructs a new up.Params instance.
Adds a new entry with the given name and value.
Adds all entries from the given list of params.
Adds params from the given HTML form field.
Removes all params from this object.
Deletes all entries with the given name.
Constructs a new up.Params instance from one or more
HTML form field.
Constructs a new up.Params instance from the given <form>.
Constructs a new up.Params instance from the given URL's
query string.
Returns the first param value with the given name from the given params.
Sets the value for the entry with given name.
Returns the given URL without its query string.
Returns an array representation of this up.Params instance.
Returns a FormData representation
of this up.Params instance.
Returns an object representation of this up.Params instance.
Returns an query string for this up.Params instance.
Builds an URL string from the given base URL and
this up.Params instance as a query string.
If passed an up.Params instance, it is returned unchanged.
Otherwise constructs an up.Params instance from the given value.