# lru-queue

> LRU Queue

Latest version **0.1.0** (published 2014-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install lru-queue
pnpm add lru-queue
yarn add lru-queue
bun add lru-queue
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-04-26 |
| First published | 2014-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Mariusz Nowak |
| Maintainers | medikoo |
| Keywords | lru, cache, queue |

## Links

- npm: https://www.npmjs.com/package/lru-queue
- Repository: https://github.com/medikoo/lru-queue
- Issues: https://github.com/medikoo/lru-queue/issues
- npm.io page: https://npm.io/package/lru-queue

## Dependencies (1)

- [es5-ext](https://npm.io/package/es5-ext.md) ~0.10.2

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2014-04-26

## README

# lru-queue
## Size limited queue based on [LRU](http://en.wikipedia.org/wiki/Least_Recently_Used#LRU) algorithm

_Originally derived from [memoizee](https://github.com/medikoo/memoize) package._

It's low-level utility meant to be used internally within cache algorithms. It backs up [`max`](https://github.com/medikoo/memoize#limiting-cache-size) functionality in [memoizee](https://github.com/medikoo/memoize) project.

### Installation

	$ npm install lru-queue

To port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: [Browserify](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/)

### Usage

Create queue, and provide a limit

```javascript
var lruQueue = require('lru-queue');
var queue = lruQueue(3); // limit size to 3
```

Each queue exposes three methods:

#### queue.hit(id)

Registers hit for given _id_ (must be plain string).

```javascript
queue.hit('raz'); // size: 1
```

If hit doesn't remove any old item from list it returns `undefined`, otherwise it returns removed _id_.


```javascript
queue.hit('dwa');    // undefined, size: 2
queue.hit('trzy');   // undefined, size: 3 (at max)
queue.hit('raz');    // undefined, size: 3 (at max)
queue.hit('dwa');    // undefined, size: 3 (at max)
queue.hit('cztery'); //  'trzy', size: 3 (at max)

```

#### queue.delete(id);

_id's_ can be cleared from queue externally

```javascript
queue.delete('raz'); // size: 2
queue.delete('cztery'); // size: 1
```

#### queue.clear();

Resets queue

```javascript
queue.clear(); // size: 0
```

### Tests [![Build Status](https://travis-ci.org/medikoo/lru-queue.png)](https://travis-ci.org/medikoo/lru-queue)

	$ npm test

---
_Source: https://npm.io/package/lru-queue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._