JSPM

  • Created
  • Published
  • Downloads 2197
  • Score
    100M100P100Q130791F
  • License MIT

Immutable SortedMap and SortedSet implementations for TypeScript

Package Exports

  • @rimbu/sorted
  • @rimbu/sorted/dist/main/index.js
  • @rimbu/sorted/dist/module/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rimbu/sorted) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 Try Out Rimbu 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/sorted

or

npm i @rimbu/sorted

Deno

Create a file called rimbu.ts and add the following:

export * from 'https://deno.land/x/rimbu/sorted/mod.ts';

Or using a pinned version (x.y.z):

export * from 'https://deno.land/x/rimbu/sorted@x.y.z/mod.ts';

Then import what you need from rimbu.ts:

import { SortedMap } 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

Usage

import { SortedSet } from '@rimbu/sorted';

console.log(SortedSet.of(1, 3, 4, 2, 3).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.