DoneJS StealJS jQuery++ FuncUnit DocumentJS
6.6.1
5.33.3 4.3.0 3.14.1 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-bind
      • can-compute
      • can-debug
      • can-deep-observable
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-backup
      • can-define-stream
      • can-define-stream-kefir
      • can-event-queue
      • can-kefir
      • can-list
      • can-map
      • can-map-compat
      • can-map-define
      • can-observable-array
      • can-observable-object
      • can-observation
      • can-observation-recorder
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
      • can-value
    • Views
      • can-attribute-observable
      • can-component
      • can-observable-bindings
      • can-stache
      • can-stache-bindings
      • can-stache-converters
      • can-stache-element
      • can-stache-route-helpers
      • can-view-autorender
      • can-view-callbacks
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-parser
      • can-view-scope
      • can-view-target
      • steal-stache
    • Data Modeling
      • can-connect
        • behaviors
          • ./base/
          • ./cache-requests/
          • ./can/constructor-hydrate/
          • ./can/map/
          • ./can/ref/
          • ./can/session/
          • ./can-local-store
          • ./can-memory-store
          • ./constructor/callbacks-once/
          • ./constructor/
          • ./constructor/store/
          • ./data/callbacks/
          • ./data/callbacks-cache/
          • ./data/combine-requests/
          • ./data/parse/
          • ./data/url/
          • ./data/worker/
          • ./fall-through-cache/
          • ./real-time/
        • modules
          • ./can/tag/
          • ./helpers/map-deep-merge
          • ./helpers/weak-reference-map
        • data types
          • DataInterface
          • Instance
          • InstanceInterface
          • List
          • ListData
        • deprecated
          • ./can/base-map/
          • ./can/merge/
          • ./can/super-map/
          • ./data/localstorage-cache/
          • ./data/memory-cache/
      • can-connect-ndjson
      • can-connect-tag
      • can-define-realtime-rest-model
      • can-define-rest-model
      • can-fixture
      • can-fixture-socket
      • can-local-store
      • can-memory-store
      • can-ndjson-stream
      • can-query-logic
      • can-realtime-rest-model
      • can-rest-model
      • can-set-legacy
      • can-super-model
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-hash
      • can-route-mock
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-diff
      • can-globals
      • can-join-uris
      • can-key
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-queues
      • can-string
      • can-string-to-any
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-child-nodes
      • can-control
      • can-dom-data
      • can-dom-events
      • can-dom-mutate
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-fragment
    • Data Validation
      • can-type
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-data-types
      • can-namespace
      • can-reflect
      • can-reflect-dependencies
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

map-deep-merge

  • Edit on GitHub

Perform a smart merge of deeply nested maps and lists.

mapDeepMerge( instance, data )

The can-connect/helpers/map-deep-merge module exports a function that merges nested can-define/map/map or can-define/list/list instances.

var mapDeepMerge = require('can-connect/helpers/map-deep-merge');

var type = new Type({ ... });

mapDeepMerge(type, { ... });

var list = new Type.List([ ... ]);
mapDeepMerge(list, [ ... ]);

To properly know how to merge can-define instances of a can-define/list/list, mapDeepMerge needs to know how to:

  • uniquely identify the instances
  • create instances from raw data (hydration)

mapDeepMerge solves this by first identifying the [can-define.types.TypeConstructor] of the # (index) property definition.

With the Type known of each item in the list, mapDeepMerge looks for for a Type.algebra to specify the unique [can-set.props.id] of Type instances. If Type.algebra does not exist, it looks for an id and then _id property.

With the Type known of each item in the list, mapDeepMerge looks for a Type.connection.hydrateInstance(props) method. If one does not exist, new Type(props) is used instead.

Parameters

  1. instance {can-define/map/map|can-define/map/list}:

    An instance to apply a merge to.

  2. data {Object|Array}:

    An object or array with the updated data.

Use

This method is often used by mixing in the can/merge behavior into a connection.

It can be used directly to update a can-define/map/map instance or can-define/list/list instance with nested data as follows:

var mapDeepMerge = require("can-connect/helpers/map-deep-merge");

var myMonth = new ContributionMonth({
    id: 1,
    month: "Feb",
    osProjects: [ { id: 1, title: "canjs" }, {id: 2, title: "jQuery++"} ],
    author: {id: 5, name: "ilya"}
});

mapDeepMerge( myMonth, {
    id: 1,
    month: "February",
    osProjects: [ { id: 1, title: "CanJS" }, {id: 3, title: "StealJS"}, {id: 2, title: "jQuery++"} ],
    author: {id: 6, name: "ilya"}
});

This will create the following changes:

// 1 - a property update
contributionMonth.name = "February";
// 2 - a property update on an item of a list
contributionMonth.osProjects[0].name = "CanJS";
// 3 - item insertion
contributionMonth.osProjects.splice(1,0, hydrateInstance({id: 3, name: "StealJS"}) )
 // 4 - a map replacement (`id` is different)
contributionMonth.author = hydrateInstance( {id: 6, name: "ilya"} )

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 6.6.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news