cachu

cachu

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

Why should you use cachu?

• fully asynchronous
• small n' easy
• zero dependencies

Installation

Install the Package

Install it using your favorite package manager.

npm i cachu
yarn add cachu

Class Instance

Recommended if you need multiple caches.

import { Cachu } from 'cachu'

const cache = new Cachu({
  max: 10, // cache can contain up to 10 items
  maxAge: 60 // delete items after a minute
})

(async () => {
  await cache.setItem(123, 'hello world')
  console.log(await cache.getItem(123))
})()

Global Instance

Recommended if you need only one cache or want to configure cachu globally.

import cachu, { setItem, getItem } from 'cachu'

// configure cachu globally (optional)
cachu({
  max: 10, // cache can contain up to 10 items
  maxAge: 60 // delete items after a minute
})

(async () => {
  await setItem(123, 'hello world')
  console.log(await getItem(123))
})()

API

Configuration

• maxAge to set the maximum age for each item in the store
• maxAmount to set the maximum size for the store

Features

• set(key, value, maxAge)
• get(key)
• update(key, value)
• view(key)
• purge(key)
• has(key)
• prune()
• destroy()
• purgeMany(keys)
• getMany(keys)
• getAmountOfItems()
• getManyByCondition(condition)
• purgeManyByCondition(condition)
• getValuesOfItems()
• getKeysOfItems()
• each()