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

2.1.2 • Public • Published

npm version Deno

Licence

@rimbu/hashed

This package contains the implementation for the HashMap and HashSet types, which form the basis of all Rimbu Hashed collections. The collections use a Hasher instance that is configurable to determine the equality of values/objects.

This package exports the following main types:

Name Description
HashMap<K, V> a map with entries of key type K and value type V, where keys are hashed with a Hasher
HashSet<T> a set of value type T where items are hashed with a Hasher

For complete documentation please visit the Map or Set page Rimbu Docs, or directly see the Rimbu Hashed 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/hashed

For npm:

npm i @rimbu/hashed

For bun:

bun add @rimbu/hashed

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

import { HashSet } from '@rimbu/hashed';

console.log(HashSet.of(1, 3, 2, 4, 3, 1).toString());

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.

Package Sidebar

Install

npm i @rimbu/hashed

Homepage

rimbu.org

Weekly Downloads

2,855

Version

2.1.2

License

MIT

Unpacked Size

637 kB

Total Files

153

Last publish

Collaborators

  • vitoke