https://github.com/renie/cacherequest

Cache your AJAX Requests
https://github.com/renie/cacherequest

Last synced: about 2 months ago
JSON representation

Cache your AJAX Requests

• Host: GitHub
• URL: https://github.com/renie/cacherequest
• Owner: renie
• License: mpl-2.0
• Created: 2015-05-03T00:29:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-05-03T19:46:21.000Z (over 9 years ago)
• Last Synced: 2024-11-11T18:45:34.106Z (about 2 months ago)
• Language: JavaScript
• Size: 152 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cache Request

## What is this?

It's just a class for caching responses from ajax. This does **NOT** allow a full offline operation. You should use this for other purposes like:

- Respond quickly to user on some information that doesn't have to be realtime;

- Give a valid, but not so new, information when device is offline;

- Get a valid cached information while wait for real request (*soon*)

## Requiremets

For now, it's depends on jQuery for doing requests. It will be improved soon.

Sorry about this =(

**[update 3/5/15]**

It's already possible to use this cache without jQuery. **However, it's not recommended**. It was not well tested yet.

If want use this without jQuery even knowing this is not ready. It's simple, if jQuery is not present, automatically it will use its own implementation of XMLHTTPRequest.

## Install

*bower install cache-requests*

## How to use?

Just include **cacherequest.min.js** in your html and everything is ready!

So you just have to call **CacheRequest.send()** passing a json as parameter.

This json is the same you already pass to jQuery, but you can pass two more options:

- **cacheTimeout** (integer) (default: 300000. A.K.A.: 5min)

	- time(milliseconds) you want to make you cached information valid.

- **useOldIfError** (bool) (default: false)

	- if an error happened on request, or if there is no connection, a cache can be returned even if it is expired?

## How do you test this?

For now, manually. You can run **node server.js** and access **localhost:3000**.

It will open a page with lib imported on dev mode and jquery.

So you can change on **server.js** the server's response, execute things like this below on console and check your network tab and localhost:

- CacheRequest.send({url:'/ok', complete:function(){debugger}})

- CacheRequest.send({url:'/ok', complete:function(){debugger}, useOldIfError:true})

- CacheRequest.send({url:'/ok', complete:function(){debugger}, cacheTimeout:800000})