@rimbu/list
The List is an immutable ordered sequence of elements that can be manipulated and accessed randomly in a relatively efficient way.
For complete documentation please visit the List page in the Rimbu Docs, or directly see the Rimbu List 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/list
or
npm i @rimbu/list
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
Usage
import { List } from '@rimbu/list';
console.log(List.of(1, 3, 2, 4, 3, 1).toString());
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.