@rimbu/sorted
v2.1.2
Published
Immutable SortedMap and SortedSet implementations for TypeScript
Downloads
19,503
Maintainers
Readme
@rimbu/sorted
This package contains the implementation for the SortedMap
and SortedSet
types, which form the basis of all Rimbu Sorted collections. The collections use a Comp
instance that is configurable to determine the equality and order of values/objects.
This package exports the following types:
| Name | Description |
| ----------------- | -------------------------------------------------------------------------------------- |
| SortedMap<K, V>
| a map with entries of key type K and value type V, where keys are sorted with a Comp
|
| SortedSet<T>
| a set of value type T where items are sorted with a Comp
|
For complete documentation please visit the Map or Se page in the Rimbu Docs, or directly see the Rimbu Sorted 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/sorted
For npm
:
npm i @rimbu/sorted
For bun
:
bun add @rimbu/sorted
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 { SortedSet } from '@rimbu/sorted';
console.log(SortedSet.of(1, 3, 4, 2, 3).toString());
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.