@rimbu/deep

Offers tools to use handle plain JS objects as immutable objects. The Patch object allows convenient immutable modification of simple objects. The Match object allows easy matching on plain objects. The Path object allows easy querying of nested values. The Immutable type makes it easy to create plain objects that that have compile-time protection against mutation. The Tuple type is a utility to have similar functionality as as const but less strict.

For complete documentation please visit the Immutable Objects overview in the Rimbu Docs, or directly see the Rimbu Deep API Docs.

Or Try Out Rimbu in CodeSandBox.

Installation

Compabitity

• Node >= 16
• Deno
• Bun >= 0.6.0
• Web

Yarn / NPM / Bun

For convenience, all main types are also exported through @rimbu/core.

To install this package only:

For yarn:

yarn add @rimbu/deep

For npm:

npm i @rimbu/deep

For bun:

bun add @rimbu/deep

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/[email protected]/"
  }
}

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

Usage

import { patch } from '@rimbu/deep';

console.log(
  patch({
    a: 'a',
    b: { c: 1, d: true },
  })({
    a: 'q',
    b: { c: (v) => v + 1 },
  })
);
// => { a: 'q', b: { c: 2, d: 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.