Package Exports

@rimbu/table
@rimbu/table/custom
@rimbu/table/dist/main/main/index.js
@rimbu/table/dist/module/main/index.js
@rimbu/table/hash-row
@rimbu/table/sorted-row

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/table) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@rimbu/table

A Table is an immutable 2-dimensional Map, containing row keys and column keys, where a combination of a row and column key can contain one value.

This package exports the following main types:

Name	Description
`Table<R, C, V>`	a generic `Table` with row keys R, column keys C, and values V
`VariantTable<R, C, V>`	a type-variant `Table` with row keys R, column keys C, and values V

For complete documentation please visit the Table page in the Rimbu Docs, or directly see the Rimbu Table API Docs.

Or Try Out Rimbu in CodeSandBox.

Installation

For convenience, all main types are also exported through @rimbu/core.

To install separately:

Yarn/NPM

yarn add @rimbu/table

npm i @rimbu/table

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/rimbu@x.y.z/"
  }
}

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

Because Rimbu uses advanced types, this may slow down the type checking part when running your code. If you're able to rely on your code editor to provide type errors, you can skip the Deno type check using the --no-check flag:

deno run --import-map import_map.json --no-check src/main.ts

Author

Arvid Nicolaas

Contributing

Feel very welcome to contribute to further improve Rimbu. Please read our Contributing guide.

Contributors

Made with contributors-img.

License

See LICENSE for more information.