You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
3.1 KiB
90 lines
3.1 KiB
12 months ago
|
export class LRUMap<K, V> {
|
||
|
|
// Construct a new cache object which will hold up to limit entries.
|
||
|
|
// When the size == limit, a `put` operation will evict the oldest entry.
|
||
|
|
//
|
||
|
|
// If `entries` is provided, all entries are added to the new map.
|
||
|
|
// `entries` should be an Array or other iterable object whose elements are
|
||
|
|
// key-value pairs (2-element Arrays). Each key-value pair is added to the new Map.
|
||
|
|
// null is treated as undefined.
|
||
|
|
constructor(limit: number, entries?: Iterable<[K, V]>);
|
||
|
|
|
||
|
|
// Convenience constructor equivalent to `new LRUMap(count(entries), entries)`
|
||
|
|
constructor(entries: Iterable<[K, V]>);
|
||
|
|
|
||
|
|
// Current number of items
|
||
|
|
size: number;
|
||
|
|
|
||
|
|
// Maximum number of items this map can hold
|
||
|
|
limit: number;
|
||
|
|
|
||
|
|
// Least recently-used entry. Invalidated when map is modified.
|
||
|
|
oldest: Entry<K, V>;
|
||
|
|
|
||
|
|
// Most recently-used entry. Invalidated when map is modified.
|
||
|
|
newest: Entry<K, V>;
|
||
|
|
|
||
|
|
// Replace all values in this map with key-value pairs (2-element Arrays) from
|
||
|
|
// provided iterable.
|
||
|
|
assign(entries: Iterable<[K, V]>): void;
|
||
|
|
|
||
|
|
// Put <value> into the cache associated with <key>. Replaces any existing entry
|
||
|
|
// with the same key. Returns `this`.
|
||
|
|
set(key: K, value: V): LRUMap<K, V>;
|
||
|
|
|
||
|
|
// Purge the least recently used (oldest) entry from the cache.
|
||
|
|
// Returns the removed entry or undefined if the cache was empty.
|
||
|
|
shift(): [K, V] | undefined;
|
||
|
|
|
||
|
|
// Get and register recent use of <key>.
|
||
|
|
// Returns the value associated with <key> or undefined if not in cache.
|
||
|
|
get(key: K): V | undefined;
|
||
|
|
|
||
|
|
// Check if there's a value for key in the cache without registering recent use.
|
||
|
|
has(key: K): boolean;
|
||
|
|
|
||
|
|
// Access value for <key> without registering recent use. Useful if you do not
|
||
|
|
// want to chage the state of the map, but only "peek" at it.
|
||
|
|
// Returns the value associated with <key> if found, or undefined if not found.
|
||
|
|
find(key: K): V | undefined;
|
||
|
|
|
||
|
|
// Remove entry <key> from cache and return its value.
|
||
|
|
// Returns the removed value, or undefined if not found.
|
||
|
|
delete(key: K): V | undefined;
|
||
|
|
|
||
|
|
// Removes all entries
|
||
|
|
clear(): void;
|
||
|
|
|
||
|
|
// Returns an iterator over all keys, starting with the oldest.
|
||
|
|
keys(): Iterator<K>;
|
||
|
|
|
||
|
|
// Returns an iterator over all values, starting with the oldest.
|
||
|
|
values(): Iterator<V>;
|
||
|
|
|
||
|
|
// Returns an iterator over all entries, starting with the oldest.
|
||
|
|
entries(): Iterator<[K, V]>;
|
||
|
|
|
||
|
|
// Returns an iterator over all entries, starting with the oldest.
|
||
|
|
[Symbol.iterator](): Iterator<[K, V]>;
|
||
|
|
|
||
|
|
// Call `fun` for each entry, starting with the oldest entry.
|
||
|
|
forEach(
|
||
|
|
fun: (value: V, key: K, m: LRUMap<K, V>) => void,
|
||
|
|
thisArg?: any
|
||
|
|
): void;
|
||
|
|
|
||
|
|
// Returns an object suitable for JSON encoding
|
||
|
|
toJSON(): Array<{ key: K; value: V }>;
|
||
|
|
|
||
|
|
// Returns a human-readable text representation
|
||
|
|
toString(): string;
|
||
|
|
}
|
||
|
|
|
||
|
|
// An entry holds the key and value, and pointers to any older and newer entries.
|
||
|
|
// Entries might hold references to adjacent entries in the internal linked-list.
|
||
|
|
// Therefore you should never store or modify Entry objects. Instead, reference the
|
||
|
|
// key and value of an entry when needed.
|
||
|
|
interface Entry<K, V> {
|
||
|
|
key: K;
|
||
|
|
value: V;
|
||
|
|
}
|