API reference `up.network`
module

Features to make HTTP requests and cache their responses.

Unpoly uses this client automatically when following a link or submitting a form. To make a request from your own code, call up.request(). It returns an up.Request that fulfills with an up.Response and that can be aborted. Responses can be cached so that a later request for the same URL renders instantly, and cached content is revalidated after rendering. The cache is managed through up.cache.get(), up.cache.expire() and up.cache.evict().

Events are emitted throughout the request lifecycle. up:network:late fires when requests take longer than expected and drives the default progress bar; up:request:offline fires when a request fails without a response. Defaults for timeouts, concurrency and caching live in up.network.config.

Features

up.ajax([url], [options]) JS deprecated

Makes a request to the given URL and caches the response.
up.cache.clear() JS deprecated

Expires cache entries.
up.cache.evict([pattern]) JS

Evicts responses in the cache.
up.cache.expire([pattern]) JS

Expires entries in the cache.
up.cache.get(requestOptions) JS experimental

Returns a cached request matching the given request options.
up.network.abort([condition], [options]) JS

Aborts pending requests matching a condition.
up.network.config CONFIG

Sets default options for network requests.
up.network.isBusy() JS

Returns whether Unpoly is currently loading a request.
up.network.isIdle() JS deprecated

Returns whether Unpoly is not currently loading a request.
up:network:late EVENT

This event is emitted when requests are taking long to finish loading.
up.network.loadPage(options) JS

Makes a full-page request, replacing the entire browser environment with a new page from the server response.
up:network:recover EVENT

This event is emitted when requests have taken long to finish, but have finished now.
up.proxy.clear() JS deprecated

Expires all cache entries.
up.proxy.preload(link) JS deprecated

Preloads the given link.
up.request([url], [options]) JS

Makes a request to the given URL.
up:request:aborted EVENT

This event is emitted when a request was aborted.
up:request:load EVENT

This event is emitted before a request is sent over the network.
up:request:loaded EVENT

This event is emitted when the response to a request has been received.
up:request:offline EVENT

This event is emitted when a request encounters a fatal error, like a timeout or loss of network connectivity.

API reference up.network module

Features

API reference `up.network`
module