Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giraysam/boomerang-cache
boomerangCache is a client side caching library based on localStorage and sessionStorage
https://github.com/giraysam/boomerang-cache
cache javascript localstorage sessionstorage
Last synced: 3 months ago
JSON representation
boomerangCache is a client side caching library based on localStorage and sessionStorage
- Host: GitHub
- URL: https://github.com/giraysam/boomerang-cache
- Owner: giraysam
- License: mit
- Created: 2016-09-16T09:13:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-11T09:31:13.000Z (over 6 years ago)
- Last Synced: 2024-11-11T12:00:46.982Z (3 months ago)
- Topics: cache, javascript, localstorage, sessionstorage
- Language: JavaScript
- Homepage:
- Size: 639 KB
- Stars: 8
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Boomerang Cache
boomerangCache is a client side caching library based on localStorage.
[](https://www.npmjs.com/package/boomerang-cache)
[![npm version][npm-badge-v]][npm]
[![npm downloads][npm-badge-dm]][npm]
[![build status][travis-badge]][travis]
[![js-standard-style][code-standart-badge]](https://github.com/giraysam/boomerang-cache)
#### How to install?
Npm:
```sh
npm install boomerang-cache
```
Bower:
```sh
bower install boomerang-cache
```
### Docs
[https://giraysam.github.io/boomerang-cache](https://giraysam.github.io/boomerang-cache)
API Reference
-------------
* create
* check
* set
* get
* getAll
* length
* remove
* clear
* * *
### BoomerangCache.create
> Creates a new bucket.
#### Arguments
1. `bucket` (**String**)
2. `options` (**Object**)
* `storage`: (**local** | **session**)
* `encrypt`: (**true** | **false**)
```js
var boomerang = BoomerangCache.create('bucket1', {storage: 'local', encrypt: true});
```
### BoomerangCache.set
> Set a key to a particular value or a hash object (Object or Array) under a hash key.
#### Arguments
1. `key` (**String**)
2. `value` (**String**, **Number**, **Object**, **Array**)
3. `seconds` (**Number**) - optional
> These values will never expire and will only be removed when you (or the browser) removes them.
```js
boomerang.set('stringData', 'Hello World');
boomerang.set('numberData', 12345);
boomerang.set('objectData', {value: 'Hello World'});
boomerang.set('arrayData', [{value: 'Hello World'}, {value: 'Hello Boomerang'}]);
```
#### Set values with expire
> After 3 seconds this will return null.
```js
var seconds = 3;
boomerang.set('key', 'Hello World', seconds);
```
### BoomerangCache.get
> Returns the saved value for given key. If value is null or undefined it returns a default value.
#### Arguments
1. `key` (**String**)
2. `defaultValue` (**String**, **Number**, **Object**, **Array**)
```js
boomerang.get('key', 'Hello World'); // If value is null returns Hello World.
```
### BoomerangCache.getAll
> Returns all saved values.
```js
boomerang.getAll();
// {key1: 'value1'}, {key2: 'value2'}
```
### BoomerangCache.length
> Returns all values count.
```js
boomerang.length();
// returns 2
```
### BoomerangCache.remove
> Remove a key from storage
#### Arguments
1. `key` (**String**)
```js
boomerang.remove('key');
```
### BoomerangCache.clear
> Empties storage
```js
boomerang.clear();
```
[npm]: https://www.npmjs.org/package/boomerang-cache
[npm-badge-v]: https://img.shields.io/npm/v/boomerang-cache.svg?style=flat-square
[npm-badge-dm]: https://img.shields.io/npm/dm/boomerang-cache.svg?style=flat-square
[travis]: https://travis-ci.org/giraysam/boomerang-cache
[travis-badge]: https://travis-ci.org/giraysam/boomerang-cache.svg?branch=master
[code-standart-badge]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square