iterable-keyed-map

iterable-keyed-map

This package is a Typescript-rewriting of anko/array-keyed-map. With some additional tweakings and features.

import { IterableKeyedMap } from "iterable-keyed-map";

// init
const ikmap = new IterableKeyedMap<string, string | number>();

// set
ikmap.set(["1", "2", "3"], 1);
ikmap.set(["1", "2"], 2);
ikmap.set(["3", "2", "1"], "random string");

// get
console.log(ikmap.get(["1", "2"]));
console.log(ikmap.get(["1", "2", "3"]));
console.log(ikmap.get(["3", "2", "1"]));

// iterate (in insertion order)
console.log([...ikmap]);

// delete
ikmap.delete(["1", "2"]);

// iterate
console.log([...ikmap]);

Features

• Fully written in Typescript.
• Pure ESM package.
• Using class private fields.
• The underlying tree structure is exactly the same with anko/array-keyed-map.
• Keeping all the APIs the same with Map ensured by implements clauses.
• Iterating in insertion order.
• No dependencies.

Todos

• Support custom comparison functions.
• Unit tests.
• Code minification. (use esm.run)