cachu

cachu

Setup

# Get the latest release.
npm i cachu

Usage

import { Cache } from 'cachu'

const cache = new Cache({
  maximumAge: '10m', // 10 minutes, can be specified as number (in seconds) or readable string
  ...
})

// Add a new record.
await cache.add('one', 'Hello World')
  
const record = await cache.get('one') // 'Hello World'

API

• Configuration (optional)

  • autodelete to delete overaged entries on adding/updating (disabled by default)
  • maximumAge to set the maximum age for each record in the cache (defaults to 600s)
  • maximumAmount to set the maximum size for the cache (defaults to 10000)
  • maximumRecordSize to set the maximum size for each record (defaults to 10 KB)

• Features

  • add()
  • addMany()
  • get()
  • getMany()
  • update()
  • updateMany()
  • remove()
  • removeMany()
  • has()
  • size() (get the cache size in bytes)
  • keys()
  • values()
  • clear() (delete all overaged records manually)

Changelog

v7.0.0

Breaking Changes

• changed the way you create a new cache.

  // before v7
  import { useCache } from 'cachu'
  
  const cache = useCache({
    maxAge: '10m',
    maxAmount: 10000,
    autodelete: false
  })
  
  // v7
  import { Cache } from 'cachu'
  
  const cache = new Cache({
    maximumAge: '10m',
    maximumAmount: 10000,
    autodelete: false
  })
  

New Features

• you can now set a maximum size for each record.

  import { Cache } from 'cachu'
  
  const cache = new Cache({
    maximumRecordSize: '10 KB'
  
    // alternatively, you can specify the amount of bytes as a number
    maximumRecordSize: 10000
  })