LRU - Documentation

LRU

A Simple LRU Map
This maintains 2 maps internally and swaps them when one becomes full
NOTE: At any time size of the map will be from 0 to 2 * maxItems

Constructor

new LRU(optionsopt)

Source:

LRU.js, line 17

Example

const lru = new LRU({maxItems: 1000});
lru.set('hello', 'world');
lru.get('hello');
lru.delete('hello');

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`maxItems`	number	<optional>	max items in the lru map

Members

size

Source:

LRU.js, line 160

returns the size of the lru map (number of items in the map)

Methods

clear()

Source:

LRU.js, line 116

removes all values from the lru map

delete(key) → {boolean}

Source:

LRU.js, line 102

deletes a value from the lru map

Parameters:

Name	Type	Description
`key`	any

Returns:

whether any key was deleted

Type: boolean

get(key) → {any}

Source:

LRU.js, line 43

gets a value from the lru map

Parameters:

Name	Type	Description
`key`	any

Returns:

Type: any

has(key) → {boolean}

Source:

LRU.js, line 78

returns whether a value exists in the lru map

Parameters:

Name	Type	Description
`key`	any

Returns:

Type: boolean

(generator) keys()

Source:

LRU.js, line 125

return an iterator over the keys of the lru map

peek(key) → {any}

Source:

LRU.js, line 87

gets a value from the lru map without touching the lru sequence

Parameters:

Name	Type	Description
`key`	any

Returns:

Type: any

set(key, value)

Source:

LRU.js, line 61

sets a value in the lru map

Parameters:

Name	Type	Description
`key`	any
`value`	any

totalSize() → {number}

Source:

LRU.js, line 168

Total size (including old + new) of the LRU cache

Returns:

Type: number

(generator) values()

Source:

LRU.js, line 134

return an iterator over the values of the lru map