@collectable/sorted-map

Immutable Sorted Map

An persistent sorted map data structure with user-definable sort order

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

Installation

# via NPM
npm install @collectable/sorted-map

# or Yarn
yarn add @collectable/sorted-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/sorted-map';

const map = fromObject({ foo: 'bar' }); // => SortedMap<{ 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.

---

Documentation pending