can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - Prop</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=" parent expanded"> <a class="page" href="can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> <ul> <li class=" "> <a class="module" href="can-component.html" title="Create a custom element that can be used to manage widgets or application logic."> can-component </a> </li> <li class=" "> <a class="module" href="can-compute.html" title="Create an observable value."> can-compute </a> </li> <li class=" "> <a class="module" href="can-connect.html" title="can-connect provides persisted data middleware. Use it to assemble powerful model layers for any JavaScript project."> can-connect </a> </li> <li class=" "> <a class="module" href="can-define.html" title="Exports the define method that defines observable properties and their behavior on a prototype object."> can-define </a> </li> <li class=" "> <a class="module" href="can-define/list/list.html" title="Create observable lists."> can-define/list/list </a> </li> <li class=" "> <a class="module" href="can-define/map/map.html" title="Create observable objects."> can-define/map/map </a> </li> <li class=" "> <a class="function" href="can-route.html" title="Manage browser history and client state by synchronizing the window.location.hash with a map."> can-route </a> </li> <li class=" "> <a class="module" href="can-route-pushstate.html" title="Changes can-route to use pushstate to change the window's pathname instead of the hash. var route = require("can-route-pushstate"); route("{page}", { page: "home" }); route.ready(); route.attr("page", "user"); location.pathname; // -> "/user""> can-route-pushstate </a> </li> <li class=" parent expanded"> <a class="module" href="can-set.html" title="can-set is a utility for comparing sets that are represented by the parameters commonly passed to service requests."> can-set </a> <ul> <li> <span>types</span> <ul> <li class=" "> <a class="typedef" href="can-set/Set.html" title="An object that represents a set of data."> Set </a> </li> <li class=" "> <a class="typedef" href="can-set.compares.html" title="An object of property names and prop functions. { // return `true` if the values should be considered the same: lastName: function(aValue, bValue){ return (""+aValue).toLowerCase() === (""+bValue).toLowerCase(); } }"> Compares </a> </li> <li class="current parent expanded"> <a class="typedef" href="can-set.prop.html" title=""> Prop </a> </li> </ul> </li> <li> <span>properties</span> <ul> <li class=" "> <a class="function" href="can-set.Algebra.html" title="Perform set logic with an awareness of how certain properties represent a set."> Algebra </a> </li> <li class=" "> <a class="function" href="can-set.Translate.html" title="can-set.Translate"> Translate </a> </li> <li class=" "> <a class="property" href="can-set.props.html" title="Contains a collection of prop generating functions. The following functions create compares objects that can be mixed together to create a set Algebra. var set = require("can-set"); var algebra = new set.Algebra( { // ignore this property in set algebra sessionId: function(){ return true } }, set.props.boolean("completed"), set.props.rangeInclusive("start","end") );"> props </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-stache.html" title="Live binding Mustache and Handlebars-compatible templates."> can-stache </a> </li> <li class=" "> <a class="module" href="can-stache/helpers/route.html" title="Adds stache helpers that use can-route."> can-stache/helpers/route </a> </li> <li class=" "> <a class="module" href="can-stache-bindings.html" title="Provides template event, one-way, and two-way bindings."> can-stache-bindings </a> </li> </ul> </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=" "> <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-core.html">Core</a></li> / <li><a href="can-set.html">can-set</a></li> / <li><a href="can-set.prop.html">Prop</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>Prop</h1> <div>typedef</div> </div> <section class="description"> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-links">  <li><a href="//github.com/canjs/can-set/tree/v1.0.2/docs/can-set.comparator.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>prop(aValue, bValue, a, b, prop, algebra)</code> </h2> <p>A prop function returns algebra values for two values for a given property.</p> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>aValue</b> <code>{*}</code>: <p>The value of A's property in a set difference A and B (A B).</p> </li> <li><b>bValue</b> <code>{*}</code>: <p>The value of A's property in a set difference A and B (A B).</p> </li> <li><b>a</b> <code>{*}</code>: <p>The A set in a set difference A and B (A B).</p> </li> <li><b>b</b> <code>{*}</code>: <p>The B set in a set difference A and B (A B).</p> </li> </ol> </div> <div class="returns"> <h3 class="returns-title">Returns</h3> <p> <code>{Object|Boolean}</code>: <p>A prop function should either return a Boolean which indicates if <code>aValue</code> and <code>bValue</code> are equal or an <code>AlgebraResult</code> object that details information about the union, intersection, and difference of <code>aValue</code> and <code>bValue</code>.</p> <p>An <code>AlgebraResult</code> object has the following values:</p> <ul> <li><code>union</code> - A value the represents the union of A and B.</li> <li><code>intersection</code> - A value that represents the intersection of A and B.</li> <li><code>difference</code> - A value that represents all items in A that are not in B.</li> <li><code>count</code> - The count of the items in A.</li> </ul> <p>For example, if you had a <code>colors</code> property and A is <code>["Red","Blue"]</code> and B is <code>["Green","Yellow","Blue"]</code>, the AlgebraResult object might look like:</p> <pre><code class="language-js">{ union: ["Red","Blue","Green","Yellow"], intersection: ["Blue"], difference: ["Red"], count: 2000 } </code></pre> <p>The count is <code>2000</code> because there might be 2000 items represented by colors "Red" and "Blue". Often the real number can not be known.</p> </p> </div> </div> <section class="body"> </section> <script type="text/javascript"> var docObject = {"src":{"path":"node_modules/can-set/docs/can-set.comparator.md"},"description":"\n","type":"typedef","title":"Prop","types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"name":"can-set.prop","parent":"can-set.types","signatures":[{"code":"prop(aValue, bValue, a, b, prop, algebra)","description":"\n\nA prop function returns algebra values for two values for a given property.\n","params":[{"types":[{"type":"*"}],"name":"aValue","description":"The value of A's property in a set difference A and B (A B)."},{"types":[{"type":"*"}],"name":"bValue","description":"The value of A's property in a set difference A and B (A B)."},{"types":[{"type":"*"}],"name":"a","description":"The A set in a set difference A and B (A B)."},{"types":[{"type":"*"}],"name":"b","description":"The B set in a set difference A and B (A B)."}],"returns":{"types":[{"type":"Object"},{"type":"Boolean"}],"description":"A prop function should either return a Boolean which indicates if `aValue` and `bValue` are\nequal or an `AlgebraResult` object that details information about the union, intersection, and difference of `aValue` and `bValue`.\n\nAn `AlgebraResult` object has the following values:\n\n- `union` - A value the represents the union of A and B.\n- `intersection` - A value that represents the intersection of A and B.\n- `difference` - A value that represents all items in A that are not in B.\n- `count` - The count of the items in A.\n\nFor example, if you had a `colors` property and A is `[\"Red\",\"Blue\"]` and B is `[\"Green\",\"Yellow\",\"Blue\"]`, the\nAlgebraResult object might look like:\n\n```js\n{\n union: [\"Red\",\"Blue\",\"Green\",\"Yellow\"],\n intersection: [\"Blue\"],\n difference: [\"Red\"],\n count: 2000\n}\n```\n\nThe count is `2000` because there might be 2000 items represented by colors \"Red\" and \"Blue\". Often\nthe real number can not be known.\n"}}],"_curParam":{"types":[{"type":"*"}],"name":"b","description":"The B set in a set difference A and B (A B)."},"_curReturn":{"types":[{"type":"Object"},{"type":"Boolean"}],"description":"A prop function should either return a Boolean which indicates if `aValue` and `bValue` are\nequal or an `AlgebraResult` object that details information about the union, intersection, and difference of `aValue` and `bValue`.\n\nAn `AlgebraResult` object has the following values:\n\n- `union` - A value the represents the union of A and B.\n- `intersection` - A value that represents the intersection of A and B.\n- `difference` - A value that represents all items in A that are not in B.\n- `count` - The count of the items in A.\n\nFor example, if you had a `colors` property and A is `[\"Red\",\"Blue\"]` and B is `[\"Green\",\"Yellow\",\"Blue\"]`, the\nAlgebraResult object might look like:\n\n```js\n{\n union: [\"Red\",\"Blue\",\"Green\",\"Yellow\"],\n intersection: [\"Blue\"],\n difference: [\"Red\"],\n count: 2000\n}\n```\n\nThe count is `2000` because there might be 2000 items represented by colors \"Red\" and \"Blue\". Often\nthe real number can not be known.\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>