[](https://www.npmjs.com/package/@rimbu/sorted) [](http://deno.land/x/rimbu)
# @rimbu/sorted
Welcome to `@rimbu/sorted`! This package provides robust implementations for `SortedMap` and `SortedSet`, forming the foundation of all Rimbu Sorted collections. These collections use a configurable `Comp` instance to determine the equality and order of values/objects, ensuring efficient and reliable data management.
### Key Features:
- **Sorted Collections**: Maintain elements in a sorted order based on a configurable comparator.
- **Efficient Lookups**: Optimized for fast retrieval and manipulation of data.
- **Flexible Configurations**: Customize how elements are compared and ordered.
### Exported Types:
| Name | Description |
| ----------------- | ------------------------------------------------------------------------------------------- |
| `SortedMap` | A map with entries of key type `K` and value type `V`, where keys are sorted with a `Comp`. |
| `SortedSet` | A set of value type `T` where items are sorted with a `Comp`. |
### Documentation
For complete documentation, please visit the [Map](https://rimbu.org/docs/collections/map) or [Set](https://rimbu.org/docs/collections/set) pages in the [Rimbu Docs](https://rimbu.org), or directly explore the [Rimbu Sorted API Docs](https://rimbu.org/api/rimbu/sorted).
### Try It Out
Experience `@rimbu/sorted` in action! [Try Out Rimbu](https://codesandbox.io/s/github/vitoke/rimbu-sandbox/tree/main?previewwindow=console&view=split&editorsize=65&moduleview=1&module=/src/index.ts) on CodeSandBox.
## Installation
### Compabitity
- [`Node` ](https://nodejs.org)
- [`Deno` ](https://deno.com/runtime)
- [`Bun` ](https://bun.sh/)
- `Web` 
### Package Managers
**Yarn:**
```sh
yarn add @rimbu/sorted
```
**npm:**
```sh
npm install @rimbu/sorted
```
**Bun:**
```sh
bun add @rimbu/sorted
```
### Deno Setup
Create or edit `import_map.json` in your project root:
```json
{
"imports": {
"@rimbu/": "https://deno.land/x/rimbu@x.y.z/"
}
}
```
_Replace `x.y.z` with the desired version._
In this way you can use relative imports from Rimbu in your code, like so:
```ts
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:
```ts
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
```ts
import { SortedSet } from '@rimbu/sorted';
console.log(SortedSet.of(1, 3, 4, 2, 3).toString());
```
## Author
Created and maintained by [Arvid Nicolaas](https://github.com/vitoke).
## Contributing
We welcome contributions! Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
## Contributors
_Made with [contributors-img](https://contrib.rocks)._
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) for details.