@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 Rimbu Docs.
Or Try Me Out in CodeSandBox.
Installation
All types are exported through @rimbu/core
. It is recommended to use that package.
To install separately:
Yarn/NPM
yarn add @rimbu/hashed
or
npm i @rimbu/hashed
Deno
Create a file called rimbu.ts
and add the following:
export * from 'https://deno.land/x/rimbu/hashed/mod.ts';
Or using a pinned version (x.y.z
):
export * from 'https://deno.land/x/rimbu/hashed@x.y.z/mod.ts';
Then import what you need from rimbu.ts
:
import { HashSet } from './rimbu.ts';
Because Rimbu uses complex types, it's recommended to use the --no-check
flag (your editor should already have checked your code) and to specify a tsconfig.json
file with the settings described below.
Running your script then becomes:
deno run --no-check --config tsconfig.json <your-script>.ts
Recommended tsconfig.json
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
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.