Nascent Prototype Metaverse

    @rimbu/bimap
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.12 • Public • Published

    @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

    For convenience, all main types are also exported through @rimbu/core.

    To install this package only:

    Yarn/NPM

    yarn add @rimbu/bimap

    or

    npm i @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/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

    Because Rimbu uses advanced types, this may slow down the type checking part when running your code. If you're able to rely on your code editor to provide type errors, you can skip the Deno type check using the --no-check flag:

    deno run --import-map import_map.json --no-check 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

    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.

    Install

    npm i @rimbu/bimap

    Homepage

    rimbu.org

    DownloadsWeekly Downloads

    400

    Version

    0.9.12

    License

    MIT

    Unpacked Size

    180 kB

    Total Files

    46

    Last publish

    Collaborators

    • vitoke