*nix Programming Mammals

    @rimbu/deep
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.2 • Public • Published

    @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

    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

    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

    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.

    Install

    npm i @rimbu/deep

    Homepage

    rimbu.org

    DownloadsWeekly Downloads

    624

    Version

    0.9.2

    License

    MIT

    Unpacked Size

    107 kB

    Total Files

    51

    Last publish

    Collaborators

    • vitoke