Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
@rimbu/common
Advanced tools
This package exports common types and objects used in many other Rimbu packages.
Here is a brief overview:
Name | Description |
---|---|
CollectFun | types and values used in various collect methods in the collection. |
Comp | an interface and default implementations of comparison functions to order/sort values. |
Eq | an interface and default implementations of equality functions to check value equality |
Err | functions to easily create error throwing behavior as fallback values |
FastIterable | an Iterable implementation that can be more performant than usual iterables |
IndexRange | utilities to select index ranges in indexed collections |
OptLazy | a utility to provide values that can optionally be lazy |
Range | utility types to specify ranges for comparable types |
Reducer | an API to create reusable pieces of logic that process streams of data that can be processed in parallel |
TraverseState | a utility for loops to maintain the traversal state |
Update | a standard way to update a value |
Other than these values, there are a number of utility types that are exported that are also used throughout the collection.
For complete documentation please visit the Rimbu Docs, or directly see the Rimbu Common API Docs.
Or Try Out Rimbu in CodeSandBox.
All types are exported through @rimbu/core
. It is recommended to use that package.
To install this package separately:
yarn add @rimbu/common
or
npm i @rimbu/common
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
import { Eq } from '@rimbu/common';
console.log(Eq.stringCaseInsentitive()('abc', 'AbC'));
// => true
Feel very welcome to contribute to further improve Rimbu. Please read our Contributing guide.
Made with contributors-img.
Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.
See LICENSE for more information.
FAQs
Common types and objects used in many other Rimbu packages
The npm package @rimbu/common receives a total of 2,935 weekly downloads. As such, @rimbu/common popularity was classified as popular.
We found that @rimbu/common demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.