Package Exports
- @rimbu/list
- @rimbu/list/custom
Readme
@rimbu/list
Welcome to @rimbu/list
! This package provides an immutable, ordered sequence of elements that can be efficiently accessed and manipulated.
Key Features:
- Immutable: Ensures data integrity by preventing modifications to the original list.
- Ordered: Maintains the order of elements, allowing for predictable iteration.
- Efficient Access: Supports random access and manipulation with high performance.
Documentation
For complete documentation, please visit the List page in the Rimbu Docs, or directly explore the Rimbu List API Docs.
Try It Out
Experience @rimbu/list
in action! Try Out Rimbu on CodeSandBox.
Installation
Compabitity
Package Managers
Yarn:
yarn add @rimbu/list
npm:
npm install @rimbu/list
Bun:
bun add @rimbu/list
Deno Setup
Create or edit import_map.json
in your project root:
{
"imports": {
"@rimbu/": "https://deno.land/x/rimbu@x.y.z/"
}
}
Replace x.y.z
with the desired version.
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
Usage
import { List } from '@rimbu/list';
console.log(List.of(1, 3, 2, 4, 3, 1).toString());
Author
Created and maintained by Arvid Nicolaas.
Contributing
We welcome contributions! Please read our Contributing guide.
Contributors
Made with contributors-img.
License
This project is licensed under the MIT License. See the LICENSE for details.