neighbor-key-map

Ordered key-value map with next/previous neighbor lookups, built on btree-core.

Install

npm install neighbor-key-map

Usage

const NeighborKeyMap = require('neighbor-key-map');

const map = new NeighborKeyMap();

map.set(10, 'a');
map.set(20, 'b');
map.set(30, 'c');

map.nextKey(20);   // 30
map.prevKey(20);   // 10
map.nextEntry(25); // [30, 'c']
map.prevEntry(25); // [20, 'b']

API

| Method | Description | | --- | --- | | set(key, value) | Insert or update | | get(key) | Lookup value | | has(key) | Check key exists | | delete(key) | Remove key | | clear() | Remove all | | nextKey(key) | Next higher key | | prevKey(key) | Next lower key | | nextEntry(key) | Next higher [key, value] | | prevEntry(key) | Next lower [key, value] | | firstKey() / lastKey() | Extremes | | toArray() | All entries in order | | size | Entry count |

License

MIT