@rimbu/multimap
A Rimbu MultiMap is a Map in which each key has one or more values. For each key, it’s associated values are unique, that is, the values for each key are kept in a Set
.
This package exports the following types:
Name | Description |
---|---|
HashMultiMapHashValue<K, V> |
a multimap between hashed values of type K and hashed values of type V |
HashMultiMapSortedValue<K, V> |
a multimap between hashed values of type K and sorted values of type V |
MultiMap<K, V> |
a generic multimap between values of type K and values of type V |
SortedMultiMapHashValue<K, V> |
a multimap between sorted values of type K and hashed values of type V |
SortedMultiMapSortedValue<K, V> |
a multimap between sorted values of type K and sorted values of type V |
VariantMultiMap<K, V> |
a type-variant multimap between values of type K and values of type V |
For complete documentation please visit the Rimbu Docs.
Or Try Me Out in CodeSandBox.
Installation
All types are exported through @rimbu/core
. It is recommended to use this package.
To install separately:
yarn add @rimbu/multimap
or
npm i @rimbu/multimap
Usage
import { HashMultiMapHashValue } from '@rimbu/multimap';
console.log(HashMultiMapHashValue.of([1, 2], [1, 3], [2, 3]).toString());
recommended tsconfig settings
Rimbu uses advanced and recursive typing, potentially making the TypeScript compiler quite slow in some cases, or causing infinite recursion. It is recommended to set the following values in the tsconfig.json
file of your project:
{
"compilerOptions": {
"skipLibCheck": true,
"noStrictGenericChecks": true
}
}
Usage
Author
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.