Repository files navigation

An all-you-can-eat buffet of high-performance,persistent,immutable,functional data structures. Collect them all!

Note: This library is an ongoingwork in progress. The data structures mentioned below are all working nicely, but will probably have additional methods introduced as time goes on, and there may be some breaking changes in future versions when work commences to iron out API inconsistencies between data structures. Documentation is also somewhat lacking and out of date, but take a look at thefunctions folder for each data structure package, which is almost as good as actual documentation, due to the one-operation-per-file policy, and the comprehensive TypeScript annotations.

• A robust suite ofhigh-performance data structures for most use cases
• FullES2015 module support so that your application bundle only need grow in size according to what you actually use
• Functional API, prioritising an order of parameters best suited for currying and composition
• 🚧 API fordeep operations onnested structures
• Deep and shallowconversion to and from native types, including arrays, objects, iterables, Maps and Sets
• Complete set ofTypeScript definitions
• Extensivedocumentation andexamples
• One package import to access everything,or isolated npm packages for each individual data structure
• Comprehensive unit test suite, consisting of hundreds of tests for every data structure
• Strong focus on a code style thatemphasises high performance internally

• [List ] A persistentlist/vector structure based on a modifiedRRB Tree implementation.
• [Map ] A persistenthash map, mapping keys to values. Implemented as a Clojure-stylehash array mapped trie.
• [Sorted Map ] A persistent sortedmap backed by ared-black tree and ahash map with user-definable sort order.
• [Set ] A persistentset, backed by ahash map.
• [Sorted Set ] A persistent sortedset backed by ared-black tree and ahash map, with user-definable sort order.
• [Red Black Tree ] A persistentred-black tree, providing a balanced binary search tree which maps keys to values.

See theroad map for information on further development and plans for additional features and data structures.

# via NPMnpm install collectable# or Yarnyarn add collectable

TypeScript type definitions are built in.

API Reference:[General|List|Map|Sorted Map|Set|Sorted Set|Red Black Tree|Others... ]

• Map implementation adapted fromTylor Steinberger'sTypeScript conversion ofMatt Bierner's HAMT implementation.

Want to help out? Seethe guide for contributors.