@rimbu/bimap
v2.0.3
Published
A bidirectional immutable Map of keys and values for TypeScript
Downloads
18,609
Maintainers
Readme
@rimbu/bimap
A BiMap is a bidirectional Map of keys and values, where each key has exactly one value, and each value has exactly one key. There is a one-to-one mapping between keys and values.
This package exports the following types:
| Name | Description |
| ------------------- | ---------------------------------------------------------------------------------------------- |
| BiMap<K, V>
| a generic BiMap between keys of type K and values of type V |
| HashBiMap<K, V>
| a BiMap between keys of type K and values of type V, where both the keys and values are hashed |
| SortedBiMap<K, V>
| a BiMap between keys of type K and values of type V, where both the keys and values are sorted |
For complete documentation please visit the BiMap page in the Rimbu Docs, or directly see the Rimbu BiMap API Docs.
Or Try Out Rimbu in CodeSandBox.
Installation
Compabitity
Yarn / NPM / Bun
For convenience, all main types are also exported through @rimbu/core
.
To install this package only:
For yarn
:
yarn add @rimbu/bimap
For npm
:
npm i @rimbu/bimap
For bun
:
bun add @rimbu/bimap
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/[email protected]/"
}
}
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
import { HashBiMap } from '@rimbu/bimap';
const biMap = HashBiMap.of([1, 'a'], [2, 'b'], [3, 'b']);
console.log(biMap.toString());
// HashBiMap(3 -> b)
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.