@rimbu/core

This package exports all the Rimbu collections, plus the contents of the @rimbu/common package. Its aim is to provide an easy to use access point for the collections.

For complete documentation please visit the Rimbu Docs, or directly see the Rimbu Core API Docs.

Or Try Out Rimbu in CodeSandBox.

Installation

Compabitity

• Node >= 16
• Deno
• Bun >= 0.6.0
• Web

Yarn / NPM / Bun

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

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!

In this way you can use relative imports from Rimbu in your code, like so:

import { List } from '@rimbu/core/mod.ts';
import { HashMap } from '@rimbu/hashed/mod.ts';

Note that for sub-packages, due to conversion limitations it is needed to import the index.ts instead of mod.ts, like so:

import { HashMap } from '@rimbu/hashed/map/index.ts';

To run your script (let's assume the entry point is in src/main.ts):

deno run --import-map import_map.json src/main.ts

Usage

Direct imports

import { List, Stream, SortedMap } from '@rimbu/core';

const list = List.of(1, 3, 2, 4, 2);

const stream = Stream.from(list).map((v) => [v, String(v * 2)]);

const map = SortedMap.from(stream);

console.log(map.toArray());
// => [[1, '2'], [2, '4'], [3, '6'], [4, '8']]

Using the creation 'menu'

The same code using the creation 'menu':

import Rimbu from '@rimbu/core/menu';

const list = Rimbu.List.of(1, 3, 2, 4, 2);

const stream = Rimbu.Stream.from(list).map((v) => [v, String(v * 2)]);

const map = Rimbu.Map.Sorted.from(stream);

console.log(map.toArray());
// => [[1, '2'], [2, '4'], [3, '6'], [4, '8']]

Contents

This package exports everything from the following packages:

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/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/proximity	provides ProximityMap, that retrieves values based on key proximity
@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 value.

Author

Arvid Nicolaas

Contributing

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

Contributors

Made with contributors-img.

License

Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.

See LICENSE for more information.