Needless Patchouli Manufacture

    deep-clone-map
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.1 • Public • Published

    Deep Clone Map

    npm version

    Install | API | Usage | Tests | TypeScript

    Deep Clone Map maps any object or array and transforms its primitive values, always returning a new instance, it can map deeply nested values in complex objects and arrays. Think of it as Array.prototype.map() on steriods, capable to map objects and deeply nested structure.

    Differences between other deep map libraries

    Most existing libraries do not map values in arrays, and in nested complex structures combining both objects and arrays. Typescript support is also one of the lacking features of most existing libraries. A big advantage of Deep Clone Map is that it has zero dependencies.

    Size

    Deep Clone Map size is really tiny somewhere between 242 bytes up to 440 bytes minified and gzipped, depending on the algorithm used.

    Performance

    Deep Clone Map has a performance on par with other popular alternatives, but it doesn't use any dependencies, and in some instances provides more functionality.

    Some benchmarks running on MacOS Catalina and Node v12.13.0 using benchmark library:

    Mapping a primitive to another primitive
    deep-clone-map 1,433,245 ops/sec ±0.53% (92 runs sampled)
    deep-map 1,131,833 ops/sec ±0.66% (88 runs sampled)
    map-obj 1,344,719 ops/sec ±1.25% (87 runs sampled)
    Mapping a primitive to an object
    deep-clone-map 1,280,181 ops/sec ±1.61% (86 runs sampled)
    deep-map 1,004,223 ops/sec ±0.90% (90 runs sampled)
    map-obj 871,818 ops/sec ±2.38% (87 runs sampled)

    The code for benchmarks is located under the benchmark folder in the github repository.

    Install

    npm:

    npm install --save deep-clone-map

    yarn:

    yarn add deep-clone-map

    API

    deepCloneMap(any, mapFn?)

    Argument Type Description
    arg0 any Any object, array or primitive whose values should be resolved.
    arg1? (arg0: any, key: string) => any Callback used to transform primitive values, this parameter is optional if skipped, the object/array will be just deeply cloned instead.
    Arguments:
    • value The existing primitive value to be transformed.
    • key The key of the value that will be transformed, it will always be a string, in case of nested arrays and objects expect something like: key1.key2.0.1.key3
    The return value is the maped value at the exact position determined by the key.

    Returns

    Returns a new deeply cloned version of the input argument value, it will maintain the exact same structure as the original object or array. In case if a primitive is provided as the first argument it will map its value to a new one, based on the callback function.

    Usage

    Import Deep Clone Map package

    import deepCloneMap from 'deep-clone-map'

    Note: the library code is ES6, if you don't have an environment that supports it, you will gonna have to transpile the module's code yourself using babel. If you are using webpack and babel you will gonna have to ignore the module specifically in your config. Otherwise you can use the already commonjs ready provided es5 module.

    For es5 support
    import deepCloneMap from 'deep-clone-map/dist/es5'
    Browser

    A browser ready bundle is provided in the node module at deep-clone-map/dist/browser/index.js

    Deeply clone an object:

    const obj = {
      a: 1,
      b: 2,
      c: {
        a: 1,
        b: 2,
        c: [1, 2, 3],
      },
    }
     
    const newObj = deepCloneMap(obj)
    // newObj !== obj && newObj.c !== obj.c && newObj.c.c !== obj.c.c

    Deeply clone an array:

    const arr = [
      [1, 2, 3],
      [
        {
          a: 1,
          b: 2,
          c: [1, 2, 3],
        },
      ],
    ]
     
    const newArr = deepCloneMap(arr)
    // newArr !== arr && newArr[1] !== arr[1] && newArr[1].c !== arr[1].c

    Deeply map an object

    const obj = {
      a: 1,
      b: 2,
      c: {
        a: 1,
        b: 2,
        c: [1, 2, 3],
      },
    }
     
    const newObj = deepCloneMap(obj, val => val + 1)
    /*
        newObj => {
          a: 2,
          b: 3,
          c: {
            a: 2,
            b: 3,
            c: [2, 4, 4]
          }
        }
      */

    Deeply custom map an object based on the key

    const obj = {
      a: 1,
      b: 2,
      c: {
        a: 1,
        b: 2,
        c: [1, 2, 3],
      },
    }
     
    const newObj = deepCloneMap(obj, (val, key) => {
      switch (key) {
        case 'a':
          return 10
        case 'c.b':
          return 20
        case 'c.c[1]':
          return 20
        default:
          return val
      }
    })
    /*
        newObj => {
          a: 10,
          b: 2,
          c: {
            a: 1,
            b: 20,
            c: [1, 20, 3]
          }
        }
      */

    Deeply map a nested array

    const arr = [
      [1, 2, 3],
      [
        {
          a: 1,
          b: [1, 2, 3],
          c: [
            {
              a: 1,
              b: [1, 2, 3],
            },
          ],
        },
      ],
    ]
     
    const newArr = deepCloneMap(arr, val => val + 1)
    /*
        newArr => [
          [2, 3, 4],
          [
            {
              a: 2,
              b: [2, 3, 4],
              c: [
                {
                  a: 2,
                  b: [2, 3, 4]
                }
              ]
            }
          ]
        ]
      */

    Tests

    In order to run the provided unit tests:

      # yarn 
      yarn test
     
      # npm 
      npm test

    Typescript

    The packages comes with typescript declarations included in the package, you only need to import the module normally.

    By default the types are infered from the input argument:

    const obj = {
      a: 1,
      b: 2,
    }
     
    const newObj = deepCloneMap(obj)
    /*
        newObj => {
          a: number
          b: number
        }
      */

    In some cases you will need to provide a different type to the deepCloneMap function, for example in instances when you map the primitive values to a different type:

      const obj = {
        a: 1,
        b: 2
      }
     
      const newObj = deepCloneMap<{ a: string; b: string }>(obj, val => String(val))

    Install

    npm i deep-clone-map

    DownloadsWeekly Downloads

    43

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    2.16 MB

    Total Files

    32

    Last publish

    Collaborators

    • teod