`up.Request`

JavaScript class

A normalized description of an HTTP request.

You can queue a request using the up.request() method:

let request = up.request('/foo')
console.log(request.url)

// A request object is also a promise for its response
let response = await request
console.log(response.text)

Features

up.Request.prototype.abort([options]) JS

Aborts this request.
up.Request.prototype.background JS

Whether this request is loading in the background.
up.Request.prototype.badResponseTime JS deprecated

The number of milliseconds after which this request can cause an up:network:late event and show the progress bar.
up.Request.prototype.contentType JS

The format in which the request params will be encoded.
up.Request.prototype.context JS experimental

The context of the layer targeted by this request.
up.Request.prototype.ended JS

Returns whether this request is no longer waiting for the network.
up.Request.prototype.failContext JS experimental

The context of the layer targeted by this request in case the server responds with an error code.
up.Request.prototype.failLayer JS

The layer targeted by this request in case the server responds with an error code.
up.Request.prototype.failMode JS

The mode of the layer targeted by this request in case the server responds with an error code.
up.Request.prototype.failTarget JS

The CSS selector targeted by this request in case the server responds with an error code.
up.Request.prototype.fragment JS

Returns the fragment matched by this request's target selector.
up.Request.prototype.fragments JS

Returns the fragments matched by this request's target selector.
up.Request.prototype.hash JS

The hash component of this request's URL.
up.Request.prototype.header(name) JS

Returns the HTTP request header value with the given name.
up.Request.prototype.headers JS

An object of HTTP headers that will be sent with this request.
up.Request.prototype.isSafe() JS experimental

Returns whether this request uses a safe HTTP method like GET.
up.Request.prototype.lateDelay JS

The number of milliseconds after which this request can cause an up:network:late event and show the progress bar.
up.Request.prototype.layer JS

The layer targeted by this request.
up.Request.prototype.loadPage() JS

Loads this request object as a full-page request, replacing the entire browser environment with a new page from the server response.
up.Request.prototype.method JS

The HTTP method for the request.
up.Request.prototype.mode JS

The mode of the layer targeted by this request.
up.Request.prototype.navigate() JS deprecated

Loads this request object as a full-page request, replacing the entire browser environment with a new page from the server response.
up.Request.prototype.origin JS

The element that triggered the request.
up.Request.prototype.originMode JS experimental

The mode of the layer from which the interaction originated.
up.Request.prototype.params JS

Parameters that should be sent as the request's payload.
up.Request.prototype.payload JS

The payload that the request will encode into its body.
up.Request.prototype.preload JS deprecated

Whether this request is preloading content.
up.Request.prototype.target JS

The CSS selector targeted by this request.
up.Request.prototype.then(onFulfilled, onRejected) JS

An up.Request is also a promise for the server response.
up.Request.prototype.timeout JS

A timeout in milliseconds.
up.Request.prototype.url JS

The requested URL.
up.Request.prototype.wrapMethod JS

Whether to wrap non-standard HTTP methods in a POST request.
up.Request.prototype.xhr JS

Returns the underlying XMLHttpRequest instance.