Package Exports
- @rimbu/table
- @rimbu/table/custom
- @rimbu/table/hash-row
- @rimbu/table/sorted-row
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
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/table
For npm:
npm i @rimbu/table
For bun:
bun add @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
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.