aboutsummaryrefslogtreecommitdiff
path: root/node_modules/quick-lru/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/quick-lru/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/quick-lru/readme.md')
-rw-r--r--node_modules/quick-lru/readme.md96
1 files changed, 96 insertions, 0 deletions
diff --git a/node_modules/quick-lru/readme.md b/node_modules/quick-lru/readme.md
new file mode 100644
index 00000000..eb811680
--- /dev/null
+++ b/node_modules/quick-lru/readme.md
@@ -0,0 +1,96 @@
+# quick-lru [![Build Status](https://travis-ci.org/sindresorhus/quick-lru.svg?branch=master)](https://travis-ci.org/sindresorhus/quick-lru) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/quick-lru/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/quick-lru?branch=master)
+
+> Simple ["Least Recently Used" (LRU) cache](https://en.m.wikipedia.org/wiki/Cache_replacement_policies#Least_Recently_Used_.28LRU.29)
+
+Useful when you need to cache something and limit memory usage.
+
+Inspired by the [`haslru` algorithm](https://github.com/dominictarr/hashlru#algorithm), but instead uses [`Map`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map) to support keys of any type, not just strings, and values can be `undefined`.
+
+
+## Install
+
+```
+$ npm install quick-lru
+```
+
+
+## Usage
+
+```js
+const QuickLRU = require('quick-lru');
+
+const lru = new QuickLRU({maxSize: 1000});
+
+lru.set('πŸ¦„', '🌈');
+
+lru.has('πŸ¦„');
+//=> true
+
+lru.get('πŸ¦„');
+//=> '🌈'
+```
+
+
+## API
+
+### new QuickLRU([options])
+
+Returns a new instance.
+
+### options
+
+Type: `Object`
+
+#### maxSize
+
+*Required*<br>
+Type: `Object`
+
+Maximum number of items before evicting the least recently used items.
+
+### Instance
+
+The instance is [`iterable`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Iteration_protocols) so you can use it directly in a [`for…of`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/for...of) loop.
+
+Both `key` and `value` can be of any type.
+
+#### .set(key, value)
+
+Set an item. Returns the instance.
+
+#### .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.
+
+#### .clear()
+
+Delete all items.
+
+#### .keys()
+
+Iterable for all the keys.
+
+#### .values()
+
+Iterable for all the values.
+
+#### .size
+
+Get the item count.
+
+
+## License
+
+MIT Β© [Sindre Sorhus](https://sindresorhus.com)