can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - diffObject</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="../../../static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../../../../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../../../../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../../../../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../../../../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../../../../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../../../../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../../../../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../../../../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p>   </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../../../../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../../../../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li class=" "> <a class="page" href="../../../guides.html" title="Welcome to CanJS! These guides are here to help you develop and improve your relationship with CanJS. After all, picking a JavaScript framework is a commitment. We want CanJS to be the framework you marry. This page helps you know how advance through the different stages of this relationship:"> Guides </a> </li> <li class=" "> <a class="page" href="../../../can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> </li> <li class=" "> <a class="page" href="../../../can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> </li> <li class=" parent expanded"> <a class="page" href="../../../can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> <ul> <li class=" "> <a class="module" href="../../../can-construct.html" title="Provides a way to easily use the power of prototypal inheritance without worrying about hooking up all the particulars yourself. Use can-construct.extend to create an inheritable constructor function of your own."> can-construct </a> </li> <li class=" "> <a class="module" href="../../../can-control.html" title="Create organized, memory-leak free, rapidly performing, stateful controls with declarative event binding. Use Control to create UI controls like tabs, grids, and context menus, and organize them into higher-order business rules with can.route. It can serve as both a traditional view and a traditional controller."> can-control </a> </li> <li class=" "> <a class="module" href="../../../can-event.html" title="Add event functionality into your objects. The canEvent object provides a number of methods for handling events in objects. This functionality is best used by mixing the canEvent object into an object or prototype. However, event listeners can still be used even on objects that don't include canEvent. All methods provided by canEvent assume that they are mixed into an object -- this should be the object dispatching the events."> can-event </a> </li> <li class=" "> <a class="module" href="../../../can-event/async/async.html" title="Makes the event system asynchronous. WARNING: This is experimental technology."> can-event/async/async </a> </li> <li class=" "> <a class="module" href="../../../can-event/batch/batch.html" title="Adds task batching abilities to event dispatching."> can-event/batch/batch </a> </li> <li class=" "> <a class="module" href="../../../can-observation.html" title="Provides a mechanism to notify when an observable has been read and a way to observe those reads called within a given function."> can-observation </a> </li> <li class=" "> <a class="module" href="../../../can-simple-map.html" title="A performant live-bound map."> can-simple-map </a> </li> <li class=" parent expanded"> <a class="page" href="../../../can-util.html" title="A set of utilities."> can-util </a> <ul> <li class=" "> <a class="module" href="../../dom.html" title="A collection of modules that operate on DOM."> can-util/dom </a> </li> <li class=" parent expanded"> <a class="module" href="../../js.html" title="Utilities for manipulating JavaScript data structures."> can-util/js </a> <ul> <li class=" "> <a class="module" href="../assign/assign.html" title="can-util/js/assign/assign"> ./assign/ </a> </li> <li class=" "> <a class="module" href="../base-url/base-url.html" title="can-util/js/base-url/base-url"> ./base-url/ </a> </li> <li class=" "> <a class="module" href="../cid/cid.html" title="can-util/js/cid/cid"> ./cid/ </a> </li> <li class=" "> <a class="module" href="../deep-assign/deep-assign.html" title="can-util/js/deep-assign/deep-assign"> ./deep-assign/ </a> </li> <li class=" "> <a class="module" href="../defaults/defaults.html" title="can-util/js/defaults/defaults"> ./defaults/ </a> </li> <li class=" "> <a class="module" href="../deparam/deparam.html" title="can-util/js/deparam/deparam"> ./deparam/ </a> </li> <li class=" "> <a class="module" href="../diff/diff.html" title="can-util/js/diff/diff"> ./diff/ </a> </li> <li class="current parent expanded"> <a class="module" href="diff-object.html" title="can-util/js/diff-object/diff-object"> ./diff-object/ </a> </li> <li class=" "> <a class="module" href="../each/each.html" title=""> ./each/ </a> </li> <li class=" "> <a class="module" href="../global/global.html" title="can-util/js/global/global"> ./global/ </a> </li> <li class=" "> <a class="module" href="../import/import.html" title="can-util/js/import/import"> ./import/ </a> </li> <li class=" "> <a class="module" href="../is-array-like/is-array-like.html" title="can-util/js/is-array-like/is-array-like"> ./is-array-like/ </a> </li> <li class=" "> <a class="module" href="../is-browser-window/is-browser-window.html" title="can-util/js/is-browser-window/is-browser-window"> ./is-browser-window/ </a> </li> <li class=" "> <a class="module" href="../is-empty-object/is-empty-object.html" title="can-util/js/is-empty-object/is-empty-object"> ./is-empty-object/ </a> </li> <li class=" "> <a class="module" href="../is-function.html" title=""> ./is-function </a> </li> <li class=" "> <a class="module" href="../is-node/is-node.html" title="Determines if your code is running in Node.js."> ./is-node/ </a> </li> <li class=" "> <a class="module" href="../is-plain-object/is-plain-object.html" title="can-util/js/is-plain-object/is-plain-object"> ./is-plain-object/ </a> </li> <li class=" "> <a class="module" href="../is-promise/is-promise.html" title="can-util/js/is-promise/is-promise"> ./is-promise/ </a> </li> <li class=" "> <a class="module" href="../is-promise-like/is-promise-like.html" title="can-util/js/is-promise-like/is-promise-like"> ./is-promise-like/ </a> </li> <li class=" "> <a class="module" href="../is-string/is-string.html" title="Determines if the provided argument is a string."> ./is-string/ </a> </li> <li class=" "> <a class="module" href="../is-web-worker/is-web-worker.html" title="Determines if the code is running with a Web Worker."> ./is-web-worker/ </a> </li> <li class=" "> <a class="module" href="../join-uris/join-uris.html" title="Join together a URI path to a base."> ./join-uris/ </a> </li> <li class=" "> <a class="module" href="../make-array/make-array.html" title="can-util/js/make-array/make-array"> ./make-array/ </a> </li> <li class=" "> <a class="module" href="../make-promise/make-promise.html" title="can-util/js/make-promise/make-promise"> ./make-promise/ </a> </li> <li class=" "> <a class="module" href="../param/param.html" title="Serialize an object into a query string."> ./param/ </a> </li> <li class=" "> <a class="module" href="../set-immediate/set-immediate.html" title="can-util/js/set-immediate/set-immediate"> ./set-immediate/ </a> </li> <li class=" "> <a class="module" href="../string/string.html" title="String utilities used by CanJS libraries"> ./string/ </a> </li> <li class=" "> <a class="module" href="../string-to-any/string-to-any.html" title="Turns a string representation of a primitive type back into the associated primitive."> ./string-to-any/ </a> </li> <li class=" "> <a class="module" href="../types/types.html" title="A stateful container for CanJS type information."> ./types/ </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="../../../can-view-callbacks.html" title="Registered callbacks for behaviors"> can-view-callbacks </a> </li> <li class=" "> <a class="module" href="../../../can-view-live.html" title="Setup live-binding between the DOM and a compute manually."> can-view-live </a> </li> <li class=" "> <a class="module" href="../../../can-view-model.html" title="Gets the ViewModel of an element."> can-view-model </a> </li> <li class=" "> <a class="module" href="../../../can-view-nodelist.html" title="Adds nesting of text nodes can.view.nodeLists are used to make sure "directly nested" live-binding sections update content correctly. Consider the following template: <div> {{#if items.length}} Items: {{#items}} <label></label> {{/items}} {{/if}} </div> The {{#if}} and {{#items}} seconds are "directly nested" because they share the same <div> parent element. If {{#items}} changes the DOM by adding more <labels>, {{#if}} needs to know about the <labels> to remove them if {{#if}} is re-rendered. {{#if}} would be re-rendered, for example, if all items were removed."> can-view-nodelist </a> </li> <li class=" "> <a class="module" href="../../../can-view-parser.html" title="Parse HTML and mustache tokens."> can-view-parser </a> </li> <li class=" "> <a class="module" href="../../../can-view-scope.html" title="Create a lookup node for keys."> can-view-scope </a> </li> <li class=" "> <a class="module" href="../../../can-view-target.html" title=""> can-view-target </a> </li> </ul> </li> <li class=" "> <a class="page" href="../../../can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../../../../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="../../../../index.html">CanJS</a></li> / <li><a href="../../../can-infrastructure.html">Infrastructure</a></li> / <li><a href="../../../can-util.html">can-util</a></li> / <li><a href="../../js.html">can-util/js</a></li> / <li><a href="diff-object.html">./diff-object/</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>diffObject</h1> <div>module</div> </div> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links">  <li><a href="//github.com/canjs/can-util/tree/v3.0.11/js/diff-object/diff-object.js#L2">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>diffObject(oldObject, newObject)</code> </h2> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>oldObject</b> <code>{Object}</code>: <p>the object to diff from</p> </li> <li><b>newObject</b> <code>{Object}</code>: <p>the object to diff to</p> </li> </ol> </div> <div class="returns"> <h3 class="returns-title">Returns</h3> <p> <code>{Array}</code>: <p>an array of object-patch objects</p> <p>Find the differences between two objects, based on properties and values</p> <p>The object-patch object format has the following keys:</p> <ul> <li><strong>property</strong>: the property key on the new object</li> <li><strong>type</strong>: the type of operation on this property: add, remove, or set</li> <li><strong>value</strong>: the new value (if type is "add" or "set")</li> </ul> <pre><code class="language-js">var diffObject = require("can-util/js/diff-object/diff-object"); console.log(diffObject({a: 1, b: 2}, {b: 3, c: 4})); // -> [{property: "a", type: "remove"}, {property: "b", type: "set": value: 3}, {property: "c", type: "add", "value": 4}] </code></pre> </p> </div> </div> <script type="text/javascript"> var docObject = {"type":"module","name":"can-util/js/diff-object/diff-object","parent":"can-util/js","src":{"line":2,"codeLine":28,"path":"node_modules/can-util/js/diff-object/diff-object.js"},"description":"","title":"diffObject","types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"signatures":[{"code":"diffObject(oldObject, newObject)","description":"\n","params":[{"types":[{"type":"Object","options":[]}],"name":"oldObject","description":"the object to diff from"},{"types":[{"type":"Object","options":[]}],"name":"newObject","description":"the object to diff to"}],"returns":{"types":[{"type":"Array","options":[]}],"description":"an array of object-patch objects\n\nFind the differences between two objects, based on properties and values\n\nThe object-patch object format has the following keys:\n- **property**: the property key on the new object\n- **type**: the type of operation on this property: add, remove, or set\n- **value**: the new value (if type is \"add\" or \"set\")\n\n```js\nvar diffObject = require(\"can-util/js/diff-object/diff-object\");\n\nconsole.log(diffObject({a: 1, b: 2}, {b: 3, c: 4})); // ->\n [{property: \"a\", type: \"remove\"},\n {property: \"b\", type: \"set\": value: 3},\n {property: \"c\", type: \"add\", \"value\": 4}]\n```\n"}}],"_curParam":{"types":[{"type":"Object","options":[]}],"name":"newObject","description":"the object to diff to"},"_curReturn":{"types":[{"type":"Array","options":[]}],"description":"an array of object-patch objects\n\nFind the differences between two objects, based on properties and values\n\nThe object-patch object format has the following keys:\n- **property**: the property key on the new object\n- **type**: the type of operation on this property: add, remove, or set\n- **value**: the new value (if type is \"add\" or \"set\")\n\n```js\nvar diffObject = require(\"can-util/js/diff-object/diff-object\");\n\nconsole.log(diffObject({a: 1, b: 2}, {b: 3, c: 4})); // ->\n [{property: \"a\", type: \"remove\"},\n {property: \"b\", type: \"set\": value: 3},\n {property: \"c\", type: \"add\", \"value\": 4}]\n```\n"},"pathToRoot":"../../../.."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="../../../static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>