Rimbu API Docs

Welcome to the Rimbu API documentation! Here you will find extensive and navigable documentation for all the collection packages. All collections can be imported directly through sub-packages, however, the the @ribu/core package also exports the same collections for convenience. In most cases, importing from @rimbu/core will be sufficient.

To read how to get started with Rimbu, see the Getting Started page.

Package overview

Package Name	Description
@rimbu/bimap	Provides BiMap implementations.
@rimbu/bimultimap	Provides BiMultiMap implementations.
@rimbu/collection-types	A convenience package that exports all the base types for Rimbu Sets and Maps.
@rimbu/common	Provides many commonly used types and utilities that can also be of use to Rimbu users.
@rimbu/core	A convenience package that exports all of the main collections
@rimbu/deep	Provides utilities to patch and match plain JavaScript objects.
@rimbu/graph	Provides many types of Graph implementations.
@rimbu/hashed	Pprovides implementations of the HashSet and HashMap.
@rimbu/list	Provides the List implementation.
@rimbu/multimap	Provides implementations for various MultiMaps.
@rimbu/multiset	Provides implementations for various MultiSets.
@rimbu/ordered	Provides various OrderedMap and OrderedSet implementations.
@rimbu/proximity	Provides ProximityMap, for retrieving a value from the closest key
@rimbu/sorted	Provides implementations for sorted maps and sets.
@rimbu/stream	Provides the Stream and AsyncStream implementations and many related utilities.
@rimbu/table	Provides implementations for tables (2-dimensional maps).