can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-map-backup</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=" "> <a class="page" href="can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> </li> <li class=" parent expanded"> <a class="page" href="can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> <ul> <li class=" "> <a class="module" href="can-ejs.html" title="EJS provides live ERB-style client-side templates."> can-ejs </a> </li> <li class=" "> <a class="module" href="can-list.html" title=""> can-list </a> </li> <li class=" "> <a class="module" href="can-map.html" title="Create observable objects."> can-map </a> </li> <li class="current parent expanded"> <a class="module" href="can-map-backup.html" title=""> can-map-backup </a> <ul> <li> <span>can-map.prototype</span> <ul> <li class=" "> <a class="function" href="can-map-backup/can-map.prototype.backup.html" title="Save the values of the properties of an Map."> backup </a> </li> <li class=" "> <a class="function" href="can-map-backup/can-map.prototype.isDirty.html" title="Check whether an Observe has changed since the last time it was backed up."> isDirty </a> </li> <li class=" "> <a class="function" href="can-map-backup/can-map.prototype.restore.html" title="Restore saved values of an Observe's properties."> restore </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-map-define.html" title="Defines the type, initial value, get, set, remove, and serialize behavior for attributes of a Map."> can-map-define </a> </li> <li class=" "> <a class="module" href="can-view-href.html" title="Sets an element's href attribute so that it's url will set the specified attribute values on can-route."> can-view-href </a> </li> </ul> </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-legacy.html">Legacy</a></li> / <li><a href="can-map-backup.html">can-map-backup</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>can-map-backup</h1> <div>module</div> </div> <section class="description"> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-social"> <li> <a class="npm-button" href="https://www.npmjs.com/package/can-map-backup"> <img src="https://img.shields.io/badge/npm%20package-3.0.0-brightgreen.svg" alt="npm package badge" /> </a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/can-map-backup" data-count-href="/canjs/can-map-backup/stargazers" data-count-api="/repos/canjs/can-map-backup#stargazers_count">Star</a> </li> </ul> <ul class="title-links">  <li><a href="//github.com/canjs/can-map-backup/tree/v3.0.0/doc/can-map-backup.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>require('can-map-backup')</code> </h2> <p>Adds a <a href="can-map-backup/can-map.prototype.backup.html" title="Save the values of the properties of an Map.">backup</a>, <a href="can-map-backup/can-map.prototype.isDirty.html" title="Check whether an Observe has changed since the last time it was backed up.">isDirty</a> and <a href="can-map-backup/can-map.prototype.restore.html" title="Restore saved values of an Observe's properties.">restore</a> method to <a href="can-map.html" title="Create observable objects.">can-map</a>.</p> <div class="returns"> <h3 class="returns-title">Returns</h3> <p> <code>{<a href="can-map.html" title="Create observable objects.">can-map</a>}</code>: <p>Exports <a href="can-map.html" title="Create observable objects.">can-map</a>.</p> </p> </div> </div> <section class="body"> <p><code>can-map-backup</code> is a plugin that provides a dirty bit for properties on an Map, and lets you restore the original values of an Map's properties after they are changed.</p> <h2>Overview</h2> <p>Here is an example showing how to use <a href="can-map-backup/can-map.prototype.backup.html" title="Save the values of the properties of an Map.">backup</a> to save values, <code><a href="can-map-backup/can-map.prototype.restore.html" title="Restore saved values of an Observe's properties.">restore</a></code> to restore them, and <code><a href="can-map-backup/can-map.prototype.isDirty.html" title="Check whether an Observe has changed since the last time it was backed up.">isDirty</a></code></p> <p>to check if the Map has changed:</p> <pre><code class="language-js">var CanMap = require("can-map"); require('can-map-backup'); var recipe = new CanMap({ title: 'Pancake Mix', yields: '3 batches', ingredients: [{ ingredient: 'flour', quantity: '6 cups' },{ ingredient: 'baking soda', quantity: '1 1/2 teaspoons' },{ ingredient: 'baking powder', quantity: '3 teaspoons' },{ ingredient: 'salt', quantity: '1 tablespoon' },{ ingredient: 'sugar', quantity: '2 tablespoons' }] }); recipe.backup(); recipe.attr('title', 'Flapjack Mix'); recipe.title; // 'Flapjack Mix' recipe.isDirty(); // true recipe.restore(); recipe.title; // 'Pancake Mix' </code></pre> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-map-backup/doc/can-map-backup.md"},"description":"\n","type":"module","title":"","types":[{"type":"can-map"}],"name":"can-map-backup","parent":"can-legacy","test":"src/test/test.html","package":{"_args":[[{"raw":"can-map-backup@3.0.0","scope":null,"escapedName":"can-map-backup","name":"can-map-backup","rawSpec":"3.0.0","spec":"3.0.0","type":"version"},"/Users/kevin/dev/canjs"]],"_from":"can-map-backup@3.0.0","_id":"can-map-backup@3.0.0","_inCache":true,"_location":"/can-map-backup","_nodeVersion":"6.7.0","_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/can-map-backup-3.0.0.tgz_1476733764646_0.5242680294904858"},"_npmUser":{"name":"daffl","email":"daff@neyeon.de"},"_npmVersion":"3.10.3","_phantomChildren":{},"_requested":{"raw":"can-map-backup@3.0.0","scope":null,"escapedName":"can-map-backup","name":"can-map-backup","rawSpec":"3.0.0","spec":"3.0.0","type":"version"},"_requiredBy":["/"],"_resolved":"https://registry.npmjs.org/can-map-backup/-/can-map-backup-3.0.0.tgz","_shasum":"f4568549e742cdff218d3998ef66957ef4717b8c","_shrinkwrap":null,"_spec":"can-map-backup@3.0.0","_where":"/Users/kevin/dev/canjs","author":{"name":"Bitovi","email":"contact@bitovi.com","url":"http://bitovi.com"},"browser":{"transform":["cssify"]},"browserify":{"transform":["cssify"]},"dependencies":{"can-compute":"^3.0.0","can-connect":"^1.0.0","can-fixture":"^1.0.0","can-jquery":"^3.0.1","can-list":"^3.0.0","can-map":"^3.0.1","can-set":"^1.0.0","can-util":"^3.0.1"},"description":"Backup and restore a Maps state","devDependencies":{"can-map-define":"^3.0.0-pre.2","can-ssr":"^0.11.6","cssify":"^0.6.0","documentjs":"^0.4.2","donejs-cli":"^0.7.0","generator-donejs":"^0.7.0","jshint":"^2.9.1","steal":"^0.14.0","steal-qunit":"^0.1.1","steal-tools":"^0.14.0","testee":"^0.2.4"},"directories":{},"dist":{"shasum":"f4568549e742cdff218d3998ef66957ef4717b8c","tarball":"https://registry.npmjs.org/can-map-backup/-/can-map-backup-3.0.0.tgz"},"gitHead":"3e62e700c384786364f30e7f14f6dc142777d86e","homepage":"https://canjs.com","keywords":["canjs"],"main":"dist/cjs/can-map-backup","maintainers":[{"name":"daffl","email":"daff@neyeon.de"},{"name":"iherndon","email":"ivan.herndon@gmail.com"},{"name":"jandjorgensen","email":"jandjorgensen@gmail.com"},{"name":"justinbmeyer","email":"justin@bitovi.com"},{"name":"matthewp","email":"matthew@matthewphillips.info"}],"name":"can-map-backup","optionalDependencies":{},"readme":"ERROR: No README data found!","scripts":{"build":"node build.js","develop":"can-serve --static --develop --port 8080","document":"documentjs","jshint":"jshint *.js --config","postversion":"git push --tags && git checkout master && git branch -D release && git push","preversion":"npm test && npm run build","release:major":"npm version major && npm publish","release:minor":"npm version minor && npm publish","release:patch":"npm version patch && npm publish","release:pre":"npm version prerelease && npm publish","test":"npm run jshint && npm run testee","testee":"testee test.html --browsers firefox","version":"git commit -am \"Update dist for release\" && git checkout -b release && git add -f dist/"},"system":{"main":"can-map-backup","configDependencies":["live-reload"],"npmIgnore":["documentjs","testee","generator-donejs","donejs-cli","steal-tools"],"npmAlgorithm":"flat"},"version":"3.0.0"},"signatures":[{"code":"require('can-map-backup')","description":"\n\nAdds a [can-map-backup/can-map.prototype.backup],\n[can-map-backup/can-map.prototype.isDirty] and\n[can-map-backup/can-map.prototype.restore] method to [can-map].\n","params":[],"returns":{"types":[{"type":"can-map"}],"description":"Exports [can-map].\n"}}],"_curReturn":{"types":[{"type":"can-map"}],"description":"Exports [can-map].\n"},"comment":" ","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>