@rimbu/deep

@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 Try Out Rimbu in CodeSandBox.

Installation

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

To install this package only:

Yarn/NPM

yarn add @rimbu/deep

or

npm i @rimbu/deep

Deno

Create a file called rimbu.ts and add the following:

export * from 'https://deno.land/x/rimbu/deep/mod.ts';

Or using a pinned version (x.y.z):

export * from 'https://deno.land/x/rimbu/deep@x.y.z/mod.ts';

Then import what you need from rimbu.ts:

import { patch } from './rimbu.ts';

Because Rimbu uses complex types, it's recommended to use the --no-check flag (your editor should already have checked your code) and to specify a tsconfig.json file with the settings described below.

Running your script then becomes:

deno run --no-check --config tsconfig.json <your-script>.ts

Recommended tsconfig.json settings

Rimbu uses advanced and recursive typing, potentially making the TS compiler quite slow. It is recommended to set the following values in the tsconfig.json file of your project:

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

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.