flexicache's Introduction

FlexiCache

Lightweight auto-balancing cache handler with zero dependencies.

FlexiCache automatically balance caches by expiration time, frequency of data accesses, access timeout, maximum stack size and/or memory limit.

Supported Platforms:

Browser
Node.js

Supported Module Definitions:

AMD (RequireJS, Xone)
CommonJS (Node.js)
Closure (Xone)
Global (window)

All Features:

Auto-cleanup cache by:
- Expiration time
- Frequency of data accesses
- Access timeout
- Maximum size (stack)
- Memory limit
Allows free combination of all the above options
Debug infos & statistics
Save / Load dump

Optional Plugins: (actually unreleased)

Redis API Adapter
Filesystem Plugin (HTML5)
Filesystem Plugin (Node.js)
LocalStorage Plugin (HTML5)

Installation

HTML / Javascript

<html>
<head>
    <script src="https://cdn.rawgit.com/nextapps-de/flexicache/master/flexicache.min.js"></script>
</head>
...

Node.js

npm install flexicache

In your code include as follows:

var FlexiCache = require("flexicache");

Or pass in options when requiring:

var cache = require("flexicache").create({/* options */});

AMD

var FlexiCache = require("./flexicache.js");

Usage (API)

Create a new cache

var cache = new FlexiCache();

alternatively you can also use:

var cache = FlexiCache.create();

Create a new cache with custom options

FlexiCache.create(options)

var cache = new FlexiCache({

    // default values:

    expire: 60 * 60 * 1000, // 1 hour
    size: 1000,
    auto: true,
    timeout: false,
    memory: false
});

Add items to a cache

Cache.add_(id, *)

cache.add(10000, 'foo');

add more complex objects:

cache.add(10025, {
    
    id: 10025,
    name: 'foo'
});

clone and add objects:

cache.add(10025, {
    
    id: 10025,
    name: 'foo'
    
}, true);

Update item of the cache

Cache.update(id, *)

cache.update(10000, 'bar');

clone and update objects:

cache.update(10025, {
    
    id: 10025,
    name: 'foo'
    
}, true);

Remove item to the cache

Cache.remove(id)

cache.remove(10025);

Destroy the cache

cache.destroy();

Initialize the cache

Cache.init(options)

cache.init();

Get info

cache.info();

Returns information about the cache, e.g.:

{
    "bytes": 3600356288,
    "id": 0,
    "auto": false,
    "expire": 3600,
    "size": 10000,
    "status": false
}

Optimize / Cleanup cache

cache.cleanup();

Author FlexiCache: Thomas Wilkerling
License: Apache 2.0 License

flexicache's People

Contributors

Stargazers

Watchers

flexicache's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

nextapps-de / flexicache Goto Github PK