Skip to content

jsnomad/cache-lite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM Badge

cache-lite CircleCI

Description

Simple node in-memory caching system

Download

The source is available for download from GitHub. Alternatively, you can install using Node Package Manager (npm):

  npm install cache-lite

Example

const CacheLite = require('cache-lite');

const cache = new CacheLite()

// Set value in the cache for 200ms
cache.set("myKey", "myData", 200).then(() => {
})

// Get value from the cache
cache.get("myKey").then((value) => {
  console.log(value); // myData
})

cache.getKeys() // [ 'myKey' ]

cache.size() // 1

//Get value from the cache after 300ms
setTimeout(() => {
  cache.get("myKey").then((value) => {
  }).catch((err) => {
    // Error: The key myKey doesn't exist in the cache
  })
}, 300);

API

###set(key, value, ttl) Returns a promises

key

Type: string

Key

value

Type: string

Value

ttl (optional)

Type: number

Time to live

###get(key) Returns a promises

key

Type: string

Key

###getKeys() Returns keys stored in the cache

###size() Returns the number of elements in the cache

###clear() Delete all cached values from the cache

Requirement

Node >= 5.0

License

MIT © Thomas Blanc-Hector

About

Node in-memory caching system

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published