# @collectable/sorted-set

> [Collectable.js] Immutable Sorted Set

Latest version **3.0.2** (published 2021-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @collectable/sorted-set
pnpm add @collectable/sorted-set
yarn add @collectable/sorted-set
bun add @collectable/sorted-set
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2021-07-05 |
| First published | 2017-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 110.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | collectable |

## Links

- npm: https://www.npmjs.com/package/@collectable/sorted-set
- Repository: https://github.com/frptools/collectable
- Homepage: https://github.com/frptools/collectable#readme
- Issues: https://github.com/frptools/collectable/issues
- npm.io page: https://npm.io/package/@collectable/sorted-set

## Dependencies (3)

- [@collectable/map](https://npm.io/package/@collectable/map.md) ^4.0.1
- [@collectable/core](https://npm.io/package/@collectable/core.md) ^5.0.1
- [@collectable/red-black-tree](https://npm.io/package/@collectable/red-black-tree.md) ^5.1.0

## Recent versions

- 3.0.2 (latest) — 2021-07-05
- 3.0.1 — 2018-01-20
- 2.3.0 — 2017-11-25
- 2.2.0 — 2017-07-12
- 2.1.0 — 2017-07-12
- 2.0.1 — 2017-07-11
- 2.0.0 — 2017-07-11
- 1.8.0 — 2017-03-27
- 1.7.0 — 2017-03-27
- 1.6.0 — 2017-03-27
- 1.5.0 — 2017-03-26
- 1.4.0 — 2017-03-25
- 1.3.0 — 2017-03-24
- 1.2.1 — 2017-03-22
- 1.2.0 — 2017-03-22
- … 2 more at https://npm.io/package/@collectable/sorted-set/versions

## README

# [![Collectable.js: Immutable Set](https://github.com/frptools/collectable/raw/master/.assets/logo.png)](https://github.com/frptools/collectable)

# Immutable Sorted Set

> An persistent sorted set data structure with user-definable sort order

[![Build Status](https://travis-ci.org/frptools/collectable.svg?branch=master)](https://travis-ci.org/frptools/collectable)
[![NPM version](https://badge.fury.io/js/%40collectable%2Fsorted-set.svg)](http://badge.fury.io/js/%40collectable%2Fsorted-set)

*This documentation is under construction. The list of functions, descriptions and examples are pending.*

## Installation

```bash
# via NPM
npm install @collectable/sorted-set

# or Yarn
yarn add @collectable/sorted-set
```

If you intend to use other data structures as well, install the main collectable package instead. It takes a dependency on each of these data structures, and so they will become available implicitly, after installation.

```bash
# via NPM
npm install collectable

# or Yarn
yarn add collectable
```

TypeScript type definitions are built in.

## Usage

Import and use the functions you need:

```js
import { fromArray } from '@collectable/sorted-set';

const set = fromArray(['X', 'Y']); // => SortedSet<[X, Y]>
const array = Array.from(set); // => [X, Y]
```

Use a modern bundler such as Webpack 2 or Rollup in order to take advantage of tree shaking capabilities, giving you maximum flexibility to use what you need while excluding anything else from the final build.

----

*Documentation pending*

---
_Source: https://npm.io/package/@collectable/sorted-set · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._