Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

quick-lru

Package Overview
Dependencies
0
Maintainers
1
Versions
14
Issues
File Explorer

Advanced tools

quick-lru

Simple “Least Recently Used” (LRU) cache

    6.1.1latest

Version published
Maintainers
1
Weekly downloads
16,503,634
decreased by-3.85%

Weekly downloads

Changelog

Source

  • Fix internal usage of toStringTag (#39) 95593b6

https://github.com/sindresorhus/quick-lru/compare/v6.1.0...v6.1.1

Readme

Source

quick-lru Coverage Status

Simple “Least Recently Used” (LRU) cache

Useful when you need to cache something and limit memory usage.

Inspired by the hashlru algorithm, but instead uses Map to support keys of any type, not just strings, and values can be undefined.

Install

$ npm install quick-lru

Usage

import QuickLRU from 'quick-lru'; const lru = new QuickLRU({maxSize: 1000}); lru.set('🦄', '🌈'); lru.has('🦄'); //=> true lru.get('🦄'); //=> '🌈'

API

new QuickLRU(options?)

Returns a new instance.

It's a Map subclass.

options

Type: object

maxSize

Required
Type: number

The maximum number of items before evicting the least recently used items.

maxAge

Type: number
Default: Infinity

The maximum number of milliseconds an item should remain in cache. By default maxAge will be Infinity, which means that items will never expire.

Lazy expiration happens upon the next write or read call.

Individual expiration of an item can be specified by the set(key, value, options) method.

onEviction

Optional
Type: (key, value) => void

Called right before an item is evicted from the cache.

Useful for side effects or for items like object URLs that need explicit cleanup (revokeObjectURL).

Instance

The instance is an Iterable of [key, value] pairs so you can use it directly in a for…of loop.

Both key and value can be of any type.

.set(key, value, options?)

Set an item. Returns the instance.

Individual expiration of an item can be specified with the maxAge option. If not specified, the global maxAge value will be used in case it is specified on the constructor, otherwise the item will never expire.

.get(key)

Get an item.

.has(key)

Check if an item exists.

.peek(key)

Get an item without marking it as recently used.

.delete(key)

Delete an item.

Returns true if the item is removed or false if the item doesn't exist.

.clear()

Delete all items.

.resize(maxSize)

Update the maxSize, discarding items as necessary. Insertion order is mostly preserved, though this is not a strong guarantee.

Useful for on-the-fly tuning of cache sizes in live systems.

.keys()

Iterable for all the keys.

.values()

Iterable for all the values.

.entriesAscending()

Iterable for all entries, starting with the oldest (ascending in recency).

.entriesDescending()

Iterable for all entries, starting with the newest (descending in recency).

.entries()

Iterable for all entries, starting with the newest (ascending in recency).

This method exists for Map compatibility. Prefer .entriesAscending() instead.

.forEach(callbackFunction, thisArgument)

Loop over entries calling the callbackFunction for each entry (ascending in recency).

This method exists for Map compatibility. Prefer .entriesAscending() instead.

.size

The stored item count.


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Keywords

FAQs

What is quick-lru?

Simple “Least Recently Used” (LRU) cache

Is quick-lru popular?

The npm package quick-lru receives a total of 13,307,469 weekly downloads. As such, quick-lru popularity was classified as popular.

Is quick-lru well maintained?

We found that quick-lru demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 26 Mar 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc