Immutable Map

An persistent/immutable/functional map (dictionary) data structure

A Clojure-style hash array mapped trie, adapted from Tylor Steinberger's TypeScript conversion of Matt Bierner's HAMT implementation.

This documentation is under construction. The list of functions, descriptions and examples are pending.

Installation

# via NPM
npm install @collectable/map

# or Yarn
yarn add @collectable/map

If you intend to use other data structures as well, install the main collectable package instead. It takes a dependency on each of these data structures, and so they will become available implicitly, after installation.

# via NPM
npm install collectable

# or Yarn
yarn add collectable

TypeScript type definitions are built in.

Usage

Import and use the functions you need:

import { fromObject, unwrap } from '@collectable/map';

const map = fromObject({ foo: 'bar' }); // => HashMap<{ foo: 'bar' }>
const obj = unwrap(map); // => { foo: 'bar' }

Use a modern bundler such as Webpack 2 or Rollup in order to take advantage of tree shaking capabilities, giving you maximum flexibility to use what you need while excluding anything else from the final build.

API

All map-manipulation functions are available from module @collectable/map.

Documentation pending