@rimbu/common
Advanced tools
Comparing version 0.5.8 to 0.5.9
{ | ||
"name": "@rimbu/common", | ||
"version": "0.5.8", | ||
"version": "0.5.9", | ||
"description": "Common types and objects used in many other Rimbu packages", | ||
@@ -36,3 +36,4 @@ "keywords": [ | ||
"files": [ | ||
"dist" | ||
"dist", | ||
"src" | ||
], | ||
@@ -54,12 +55,6 @@ "scripts": { | ||
"sideEffects": false, | ||
"devDependencies": { | ||
"@types/jest": "^26.0.23", | ||
"jest": "^26.6.3", | ||
"ts-jest": "^26.5.5", | ||
"typescript": "^4.2.4" | ||
}, | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"gitHead": "ac4608d3221339352917943ef3513192ddef5a4f" | ||
"gitHead": "0158eaad0dec4503e92cb308af952869d68faad5" | ||
} |
@@ -9,4 +9,22 @@ <p align="center"> | ||
For complete documentation please visit the _[Rimbu Docs](http://rimbu.org/rimbu-core)_. | ||
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](http://rimbu.org)_. | ||
## Installation | ||
@@ -18,7 +36,7 @@ | ||
`yarn add @rimbu/common` | ||
> `yarn add @rimbu/common` | ||
or | ||
`npm i @rimbu/common` | ||
> `npm i @rimbu/common` | ||
@@ -28,3 +46,3 @@ ## Usage | ||
```ts | ||
import { Eq } from '@rimbu/core'; | ||
import { Eq } from '@rimbu/common'; | ||
@@ -35,22 +53,2 @@ console.log(Eq.stringCaseInsentitive()('abc', 'AbC')); | ||
## Overview | ||
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. | ||
## Author | ||
@@ -57,0 +55,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
316471
0
81
6358
69