yocto-ttl-cache



The smallest and fastest TTL cache implementation in JavaScript

TOC

- Usage
- Install
- API
- Sponsors
- Backers
- Changelog
- License

Usage

$3

``sh


pnpm

pnpm add yocto-ttl-cache

yarn

yarn add yocto-ttl-cache

npm

npm i yocto-ttl-cache
`

$3

`js
import { TTLCache } from 'yocto-ttl-cache' // only named export is supported

const cache = new TTLCache(1000) // the ttl option of constructor is 1000 by default

cache.get('key') // undefined
cache.get('key', () => 'value') // get with setter, 'value'
cache.get('key', () => 'unused') // 'value' is not stale

cache.set('key', 'newValue')
cache.get('key') // 'newValue'

setTimeout(() => {
cache.get('key') // undefined, stale after ttl
}, 1000)
``

Sponsors

| 1stG | RxTS | UnTS |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|  |  |  |

Backers

| 1stG | RxTS | UnTS |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|  |  |  |

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

[MIT][] © [JounQin][]@[1stG.me][]

[1stg.me]: https://www.1stg.me
[jounqin]: https://GitHub.com/JounQin
[mit]: http://opensource.org/licenses/MIT