Code Monkey home page Code Monkey logo

cachejs's Introduction

cacheJS

Small JS lib for caching:

  • Use array as key for storing cache instead of string ( {blogId:1,type:'view'} )
  • Clear cache using context (clear blog posts of an author)
  • Support localStorage, array, cookies (WIP, only localStorage and array are available at the moment)

See the project homepage.

Installation

Using Bower:

bower install cache-js

Or grab the file source (minified).

Usage

Save cache:
cacheJS.set(key,value,ttl,context)

cacheJS.set({blogId:1,type:'view},'<h1>Blog 1</h1>');
cacheJS.set({blogId:2,type:'view},'<h1>Blog 2</h1>', null, {author:'hoangnd'});
cacheJS.set({blogId:3,type:'view},'<h1>Blog 3</h1>', 3600, {author:'hoangnd',categoryId:2});

Retrieve cache:
cacheJS.get(key)

cacheJS.get({blogId: 1,type: 'view'});

Flush cache
cacheJS.removeByKey(key)
cacheJS.removeByContext(context)

cacheJS.removeByKey({blogId: 1,type: 'view'});
cacheJS.removeByKey({blogId: 2,type: 'view'});

cacheJS.removeByContext({author:'hoangnd'});

Switch provider
cacheJS.use(providerName)

cacheJS.use('array');
cacheJS.use('array').set({blogId:1},'<h1>Blog 1</h1>')};

Event listener
cacheJS.on(event,callback)
cacheJS.unsubscribe(event,callback)

var listener = function(objectAdded){
    // do something
};
cacheJS.on('cacheAdded', listener);

cacheJS.on('cacheRemoved', function(){
    // do something
});

cacheJS.unsubscribe('cacheAdded', listener);

Supported events:

  • cacheAdded
  • cacheRemoved

For advanced usage, see the documentation.

Documentation

Start with docs/INDEX.md.

MIT. See LICENSE.txt in this directory.

Inspired by https://github.com/sonata-project/cache

cachejs's People

Contributors

hoangnd25 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.