ylru

[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/ylru.svg?style=flat-square
[npm-url]: https://npmjs.org/package/ylru
[codecov-image]: https://img.shields.io/codecov/c/github/node-modules/ylru.svg?style=flat-square
[codecov-url]: https://codecov.io/github/node-modules/ylru?branch=master
[snyk-image]: https://snyk.io/test/npm/ylru/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/ylru
[download-image]: https://img.shields.io/npm/dm/ylru.svg?style=flat-square
[download-url]: https://npmjs.org/package/ylru

hashlru inspired

hashlru is the Simpler, faster LRU cache algorithm.
Please checkout algorithm and complexity on hashlru.

ylru extends some features base on hashlru:

- cache value can be expired.
- cache value can be empty value, e.g.: null, undefined, '', 0

Usage

``ts
import { LRU } from 'ylru';

const lru = new LRU(100);
lru.set(key, value);
lru.get(key);

// value2 will be expired after 5000ms
lru.set(key2, value2, { maxAge: 5000 });
// get key and update expired
lru.get(key2, { maxAge: 5000 });
`

$3

new LRU(max) => lru

initialize a lru object.

$3

- {Number} options.maxAge: update expire time when get, value will become undefined after maxAge pass.

Returns the value in the cache.

$3

- {Number} options.maxAge: value will become undefined after maxAge pass.
If maxAge not set, value will be never expired.

Set the value for key.

$3

Get all unexpired cache keys from lru, due to the strategy of ylru, the keys' length may greater than max.

`ts
const lru = new LRU(3);

lru.set('key 1', 'value 1');
lru.set('key 2', 'value 2');
lru.set('key 3', 'value 3');
lru.set('key 4', 'value 4');

lru.keys(); // [ 'key 4', 'key 1', 'key 2', 'key 3']
// cache: {
// 'key 4': 'value 4',
// }
// _cache: {
// 'key 1': 'value 1',
// 'key 2': 'value 2',
// 'key 3': 'value 3',
// }
`

$3

reset a lru object.

`ts
const lru = new LRU(3);

lru.set('key 1', 'value 1');
lru.set('key 2', 'value 2');
lru.set('key 3', 'value 3');
lru.set('key 4', 'value 4');

lru.reset();
// cache: {
// }
// _cache: {
// }

lru.keys().length === 0;
`

License

MIT

Contributors

|
fengmk2
|
dominictarr
|
dead-horse
|
thonatos
|
mourner
|
semantic-release-bot
|
| :---: | :---: | :---: | :---: | :---: | :---: |

vagusX
|
RaoHai


This project follows the git-contributor spec, auto updated at Thu Mar 28 2024 11:52:18 GMT+0800`.