Skip to content

MobiltronInc/ps-cache

Repository files navigation

ps-cache

Build Status GitHub issues Dependency Status

A simple, yet efficient in memory caching mechanism. With extensibility in our mind we created ps-cache.

Features

  • In memory caching
  • Listeners to extend invalidation of cache mechanism via any medium.

Getting Started

var psCache = require('ps-cache');
var cache = new pscache.Cache();

//Set to cache and time to live 30 minutes
cache.set(key, value,{ ttl: cache.D.THIRTY_MINUTES });

//Set to cache without TTL
cache.set(key, value);

//Get from cache or null if doesn't exists
cache.get(key);

//Delete local only
cache.delete(key, true);

//Delete and notify any attached listener(s)
cache.delete(key);

For creating a global cache invalidation listener see pusher-ps-cache implementation.

Requirements

Node.js >= 6.0

Installation

With npm do:

npm install ps-cache -save

Running the tests

With npm do:

npm test

About

This project is funded and maintained by Mobiltron, Inc.. We ❤️ open source software!

Check out our other open source projects or say 👋 on twitter @mobiltron.

Contribute

Contributions are welcome 🤘 We encourage developers like you to help us improve the projects we've shared with the community. Please see the Contributing Guide and the Code of Conduct.

Authors

See also the list of contributors who participated in this project.

License

ps-cache is available under the MIT license. See the LICENSE file for more info.

About

ps-cache, PubSub Caching Library

Resources

License

Stars

Watchers

Forks

Packages

No packages published