cachefactory

CacheFactory

CacheFactory is a very simple and useful synchronous key-value store for the browser.

Table of Contents

• Installation
• Quick Start
• The Basics
• Working with a cache
• Working with localStorage

Installation

NPM

npm install --save cachefactory

Bower

bower install --save cachefactory

Quick Start

import { CacheFactory } from 'cachefactory';

const cacheFactory = new CacheFactory();
let cache;

// Check whether cache metadata has been initialized
// on every page refresh.
if (!cacheFactory.exists('my-cache')) {
  // Create the cache metadata. Any previously saved
  // data will be loaded.
  cache = cacheFactory.createCache('my-cache', {
    // Delete items from the cache when they expire
    deleteOnExpire: 'aggressive',

    // Check for expired items every 60 seconds
    recycleFreq: 60 * 1000
  });
}

cache.put('/books/1', { title: 'BookOne', id: 1 });

Documentation

• The Basics
• Working with a cache
• Working with localStorage
• API Reference Documentation

License

MIT License

Copyright (C) 2015-2017 CacheFactory project authors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

3.0.0 - 26 February 2017

Breaking changes

• #29 by @Delagen - TypeScript definitions have been rewritten, and the CacheFactory constructor function is now a named export of the module.

  Before:

    import CacheFactory from 'cachefactory';
  

  After:

    import { CacheFactory } from 'cachefactory';