Licence

Immutable collections and tools for TypeScript

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and more. It offers a powerful and efficient way to work with data in a safe and predictable manner. With Rimbu, you can easily create and manipulate collections of data, such as lists and maps, without the risk of accidentally modifying the original data. This not only ensures data integrity, but also makes it easier to reason about your code and catch bugs early on. Plus, our library is fully compatible with TypeScript, providing you with improved type safety and a seamless development experience. Get started with our immutable collections library today and experience the benefits of working with truly immutable data.

Quick overview of features and benefits

Ensures data integrity by preventing accidental modifications to original data
Makes it easier to reason about your code and catch bugs early on
Provides improved type safety through full compatibility with TypeScript
Offers a seamless development experience
Increases performance by reducing the need for deep copies
Enables functional programming techniques such as immutability-based change detection and simpler undo/redo
Encourages the use of immutable data structures which has benefits in concurrent and parallel programming
Simplifies testing by eliminating the need to account for side-effects
Available for Web, Node.js and Deno.

For complete documentation please visit the Rimbu Docs or the Rimbu API Docs.

Or Try Out Rimbu in CodeSandBox.

Installation

Compabitity

To get started with the immutable collections, which are exported through @rimbu/core, you can use the following.

Yarn / NPM / Bun

For yarn:

yarn add @rimbu/core

For npm:

npm i @rimbu/core

For bun:

bun add @rimbu/core

Deno

For Deno, the following approach is recommended:

In the root folder of your project, create or edit a file called import_map.json with the following contents (where you should replace x.y.z with the desired version of Rimbu):

{
  "imports": {
    "@rimbu/": "https://deno.land/x/rimbu@x.y.z/"
  }
}

Note: The trailing slashes are important!

Main exports

The main exported packages are:

Name	Description
@rimbu/bimap	a bidirectional map in which keys and values have a one-to-one mapping
@rimbu/bimultimap	a bidirectional multimap in which keys and values have a many-to-many mapping
@rimbu/collection-types	definitions for many of the generic collection types, used to derive more specific implementations
@rimbu/common	contains public types and functions that are used throughout the whole library
@rimbu/core	a convenience package that exports most of the main types from the other packages
@rimbu/deep	offers tools to use handle plain JS objects as immutable objects. library
@rimbu/graph	provides various graph implementations to represent data in forms of nodes and edges
@rimbu/hashed	provides a HashMap and HashSet implementation, using hash functions to efficiently retrieve keys
@rimbu/list	provides the List datastructure containing an ordered sequence of elements that can be manipulated and accessed randomly in an efficient way
@rimbu/multimap	provides a map in which keys and values have a one-to-many mapping
@rimbu/multiset	provides a set in which elements can occur multiple times
@rimbu/ordered	provides the OrderedSet and OrderedMap collections, that keep insertion order
@rimbu/sorted	provides a SortedMap and SortedSet implementation, using compare functions to efficiently keep the elements sorted
@rimbu/stream	contains methods to easily manipulate sequences of data
@rimbu/table	provides various Table data structures where a combination of a row key and column key maps to a single

Development: Getting started with this monorepo

Clone this repository
Run yarn

To build all the packages: yarn build To run the tests: yarn test

Author

Arvid Nicolaas

Contributing

Feel very welcome to contribute to further improve Rimbu. Please read our Contributing guide.

Contributors

Made with contributors-img.

Mentions

Special thanks go to:

Github user bglgwyng for being the very first Rimbu sponsor! Awesome!

License

See LICENSE for more information.