cachu

cachu

Simple, minimalistic key-value cache, created by Azury.

• fully asynchronous
• small n' easy
• zero dependencies

Make sure to read our 📃 Changelog

Setup

Install the Package

Install cachu using your favorite package manager.

npm i cachu
yarn add cachu

Usage

Just create a new instance, it's as easy as that!

import { MemoryCache } from 'cachu'

const cache = new MemoryCache({
  maxAmount: 420, // cache can contain up to 420 records
  maxAge: 60 // keep records for up to a minute
})

(async () => {
  await cache.write(69, 'Hello World')
  console.log(await cache.get(69)) // should give out 'Hello World'
})()

Caches

• MemoryCache
• MiniCache

API

• Configuration

  • maxAge to set the maximum age for each record in the cache
  • maxAmount to set the maximum size for the cache
  • overriding to allow overriding of entries on reading
  • hooks to extend cachu's functionality

• Features

  • write(key, value)
  • writeMany([{key, value}])
  • get(key)
  • getMany(keys)
  • update(key, value)
  • updateMany([{key, value}])
  • grab(key)
  • grabMany(keys)
  • purge(key)
  • purgeMany(keys)
  • steal(key)
  • stealMany(keys)
  • has(key)
  • prune()
  • getAmountOfEntries()
  • getValuesOfEntries()
  • getKeysOfEntries()

• Hooks

  • preWriting
  • preReading
  • preGrabbing
  • preUpdating
  • preStealing
  • prePurging
  • prePruning