https://github.com/depyronick/light-cache

Light Cache is a lightweight and simple in-memory internal cache module for NodeJS.
https://github.com/depyronick/light-cache

cache express-cache expressjs node node-cache node-js node-module nodejs nodejs-modules npm npm-cache npm-module npm-package npm-scripts npmjs

Last synced: 11 months ago
JSON representation

Light Cache is a lightweight and simple in-memory internal cache module for NodeJS.

• Host: GitHub
• URL: https://github.com/depyronick/light-cache
• Owner: depyronick
• License: mit
• Created: 2017-03-05T04:47:31.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-08T21:54:13.000Z (almost 9 years ago)
• Last Synced: 2025-03-02T12:20:47.533Z (11 months ago)
• Topics: cache, express-cache, expressjs, node, node-cache, node-js, node-module, nodejs, nodejs-modules, npm, npm-cache, npm-module, npm-package, npm-scripts, npmjs
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Light Cache

Light Cache is a lightweight and simple in-memory internal cache module for NodeJS.

### Dependencies

* [extend] - Simple function to extend objects

### Installation

Light Cache requires at least [Node.js](https://nodejs.org/) v6.10.0+ to run.

```sh

$ npm install light-cache

```

# Usage

#### Initialization

    var LightCache = require('light-cache');

	var lightCache = new LightCache("Cache Store One");

#### **lightCache.get(key)** -- *get key*

    var todoList = lightCache.get('todos');

#### **lightCache.set(key, value)** -- *set key*

    lightCache.set('todos', 'first to do');

    lightCache.set('todos', {foo: bar});

    lightCache.set('todos', [0, 1, 2]);

#### **lightCache.mget(keys)** -- *get multiple keys*

    var todoList = lightCache.mget(['todos', 'meetings']);

#### **lightCache.mset(keys, values)** -- *set multiple keys*

    var todoList = lightCache.mget(

        ['todos', 'meetings'],

        [

            {

                todo_one: 1

            },

            {

                todo_two: 2

            }

        ]

    );

#### **lightCache.exists(key)** -- *checks if a key exists*

    var isKeyExists = lightCache.exists('todos');

    // true

#### **lightCache.mexists(keys, values)** -- *checks for multiple keys if they exists*

     var areKeysExists = lightCache.mexists(['todos', 'meetings']);

     {

         todos: true,

         meetings: true

     }

#### **lightCache.del(key)** -- *deletes a key*

    lightCache.del('todos');

#### **lightCache.mdel(keys)** -- *deletes multiple keys*

    lightCache.mdel(['todos','metings']);

#### **lightCache.append(key, value)** -- *appends an object to a key*

    lightCache.append('todos', {todo:3});

#### **lightCache.prepend(key, value)** -- *prepends an object to a key*

    lightCache.prepend('todos', {todo:0});

#### **lightCache.stats()** -- *get stats*

    lightCache.stats();

    {

        get: 50,

        set: 300,

        mget: 74,

        mset: 54,

        exists: 93,

        mexists: 596,

        del: 165,

        mdel: 874,

        append: 806,

        prepend: 960

    }

#### **lightCache.flush()** -- *flush all data*

    lightCache.flush();