Skip to main content
Module

x/rimbu/graph-arrow-valued/README.md

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.
rimbu-org/rimbu
Go to Latest
File

@rimbu/graph-arrow-valued

This package contains the implementations for the ArrowValuedGraph type. It was mainly split off to a seperate package from the @rimbu/graph package to descrease build time and memory usage.

This package exports the following types:

Name Description
ArrowValuedGraph<N, V> a generic directed valued graph with nodes of type N, and edge values of type V
ArrowValuedGraphHashed<N, V> a valued directed graph with hashed nodes of type N, and edge values of type V
ArrowvaluedGraphSorted<N, V> a valued directed graph with sorted nodes of type N, and edge values of type V

For complete documentation please visit the Rimbu Docs.

Or Try Me Out in CodeSandBox.

Installation

All types are exported through @rimbu/core. It is recommended to use this package.

To install separately:

yarn add @rimbu/graph-arrow-valued

or

npm i @rimbu/graph-arrow-valued

Rimbu uses advanced and recursive typing, potentially making the TypeScript compiler quite slow in some cases, or causing infinite recursion. It is recommended to set the following values in the tsconfig.json file of your project:

{
  "compilerOptions": {
    "skipLibCheck": true,
    "noStrictGenericChecks": true
  }
}

Author

Arvid Nicolaas

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.