/admin/static/js/braveheart/docs/v1.0/module-util.html
https://bitbucket.org/esatterwhite/wallace-io · HTML · 769 lines · 394 code · 372 blank · 3 comment · 0 complexity · 79d16b246dee44fe7a1a6ed9aac34818 MD5 · raw file
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Documentation Module: util</title>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
-
- <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
-
- </head>
- <body>
- <div class="container-fluid">
- <div class="navbar navbar-fixed-top ">
- <div class="navbar-inner">
- <a class="brand" href="index.html">Documentation</a>
- <ul class="nav">
-
- <li class="dropdown">
- <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
- class="caret"></b></a>
- <ul class="dropdown-menu ">
-
- <li>
- <a href="signals.html">signals</a>
- </li>
-
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
- class="caret"></b></a>
- <ul class="dropdown-menu ">
-
- <li>
- <a href="module-accessor.html">accessor</a>
- </li>
-
- <li>
- <a href="module-analytics.html">analytics</a>
- </li>
-
- <li>
- <a href="module-array.html">array</a>
- </li>
-
- <li>
- <a href="module-assets.html">assets</a>
- </li>
-
- <li>
- <a href="module-class.html">class</a>
- </li>
-
- <li>
- <a href="module-color.html">color</a>
- </li>
-
- <li>
- <a href="module-cookie.html">cookie</a>
- </li>
-
- <li>
- <a href="module-core.html">core</a>
- </li>
-
- <li>
- <a href="module-date.html">date</a>
- </li>
-
- <li>
- <a href="module-dom.html">dom</a>
- </li>
-
- <li>
- <a href="Document.html">dom/Document</a>
- </li>
-
- <li>
- <a href="Window.html">dom/Window</a>
- </li>
-
- <li>
- <a href="module-DOMEvent.html">DOMEvent</a>
- </li>
-
- <li>
- <a href="module-DOMNode.html">DOMNode</a>
- </li>
-
- <li>
- <a href="module-element.html">element</a>
- </li>
-
- <li>
- <a href="module-elements.html">elements</a>
- </li>
-
- <li>
- <a href="module-functools.html">functools</a>
- </li>
-
- <li>
- <a href="module-iter.html">iter</a>
- </li>
-
- <li>
- <a href="module-json.html">json</a>
- </li>
-
- <li>
- <a href="module-log.html">log</a>
- </li>
-
- <li>
- <a href="module-modernizr.html">modernizr</a>
- </li>
-
- <li>
- <a href="module-number.html">number</a>
- </li>
-
- <li>
- <a href="module-object.html">object</a>
- </li>
-
- <li>
- <a href="module-operator.html">operator</a>
- </li>
-
- <li>
- <a href="module-request.html">request</a>
- </li>
-
- <li>
- <a href="module-string.html">string</a>
- </li>
-
- <li>
- <a href="module-swf.html">swf</a>
- </li>
-
- <li>
- <a href="module-url.html">url</a>
- </li>
-
- <li>
- <a href="module-useragent.html">useragent</a>
- </li>
-
- <li>
- <a href="module-util.html">util</a>
- </li>
-
- <li>
- <a href="module-XDM.html">XDM</a>
- </li>
-
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
- class="caret"></b></a>
- <ul class="dropdown-menu ">
-
- <li>
- <a href="module-assets.CSS.html">CSS</a>
- </li>
-
- <li>
- <a href="module-assets.IMG.html">IMG</a>
- </li>
-
- <li>
- <a href="module-assets.JS.html">JS</a>
- </li>
-
- <li>
- <a href="module-class.Chain.html">Chain</a>
- </li>
-
- <li>
- <a href="module-class.Class.html">Class</a>
- </li>
-
- <li>
- <a href="module-class.Events.html">Events</a>
- </li>
-
- <li>
- <a href="module-class.Interface.html">Interface</a>
- </li>
-
- <li>
- <a href="module-class.Options.html">Options</a>
- </li>
-
- <li>
- <a href="module-class.Storage.html">Storage</a>
- </li>
-
- <li>
- <a href="module-color.Color.html">Color</a>
- </li>
-
- <li>
- <a href="module-cookie.Cookie.html">Cookie</a>
- </li>
-
- <li>
- <a href="module-core.BaseRegistry.html">BaseRegistry</a>
- </li>
-
- <li>
- <a href="module-core.Type.html">Type</a>
- </li>
-
- <li>
- <a href="module-DOMEvent-Event.html">Event</a>
- </li>
-
- <li>
- <a href="module-DOMNode.Node.html">Node</a>
- </li>
-
- <li>
- <a href="module-element.Element.html">Element</a>
- </li>
-
- <li>
- <a href="module-elements.Elements.html">Elements</a>
- </li>
-
- <li>
- <a href="module-iter.Iterable.html">Iterable</a>
- </li>
-
- <li>
- <a href="module-request.JSON.html">JSON</a>
- </li>
-
- <li>
- <a href="module-request.Request.html">Request</a>
- </li>
-
- <li>
- <a href="module-request.SIGNED.html">SIGNED</a>
- </li>
-
- <li>
- <a href="module-swf.Swiff.html">Swiff</a>
- </li>
-
- <li>
- <a href="module-XDM.Rpc.html">Rpc</a>
- </li>
-
- <li>
- <a href="module-XDM.Socket.html">Socket</a>
- </li>
-
- <li>
- <a href="signals.SignalBinding.html">SignalBinding</a>
- </li>
-
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b
- class="caret"></b></a>
- <ul class="dropdown-menu ">
-
- <li>
- <a href="global.html#event:failure">failure</a>
- </li>
-
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
- class="caret"></b></a>
- <ul class="dropdown-menu ">
-
- <li>
- <a href="global.html#hooksOf">hooksOf</a>
- </li>
-
- </ul>
- </li>
-
- </ul>
- </div>
- </div>
- <div class="row-fluid">
-
- <div class="span8">
-
- <div id="main">
-
- <h1 class="page-title">Module: util</h1>
- <section>
- <header>
- <h2>
- util
- </h2>
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <div class="description">Module for utilities to solve common patterns.</div>
-
-
- <dl class="details">
-
-
-
-
-
-
- <dt class="tag-author">Author:</dt>
- <dd class="tag-author">
- <ul>
- <li>Eric Satterwhite</li>
- </ul>
- </dd>
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="util.js.html">v1.0/util.js</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- </div>
-
-
-
- <h3 class="subsection-title">Requires</h3>
- <ul>
- <li><a href="module-core.html">module:core</a></li>
- </ul>
-
-
-
-
- <h3 class="subsection-title">Members</h3>
- <dl>
-
- <dt>
- <h4 class="name" id="ComparatorRegistry"><span class="type-signature"><static> </span>ComparatorRegistry<span class="type-signature"></span></h4>
-
-
- </dt>
- <dd>
-
- <div class="description">
- Holds currently registerd ( arrayLike & dateLike )
- </div>
-
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="util.js.html">v1.0/util.js</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- </dd>
-
-
- <dt>
- <h4 class="name" id="typeOf"><span class="type-signature"><static> </span>typeOf<span class="type-signature"></span></h4>
-
-
- </dt>
- <dd>
-
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="util.js.html">v1.0/util.js</a>
- </li></ul></dd>
-
-
-
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <li><a href="module-core.html#typeOf">module:core.typeOf</a></li>
- </ul>
- </dd>
-
-
- </dl>
-
-
- </dd>
- </dl>
-
-
- <h3 class="subsection-title">Methods</h3>
- <dl>
-
- <dt>
- <h4 class="name" id="compare"><span class="type-signature"><static> </span>compare<span class="signature">(itemA, itemB)</span><span class="type-signature"></span></h4>
-
-
- </dt>
- <dd>
-
-
- <div class="description">
- Compares object that are difficult to compare, ( arrays, and Dates by default )
- </div>
-
-
-
-
-
-
- <h5>Parameters:</h5>
-
- <table class="params table table-striped">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>itemA</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
-
- <td class="description last">An item to compare</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>itemB</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
-
- <td class="description last">An item that is of the same type as itemA</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="util.js.html">v1.0/util.js</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
-
-
-
- <h5>Throws:</h5>
-
-
- <dl>
- <dt>
- <div class="param-desc">
- If it can not figure out a way to compare the objects
- </div>
- </dt>
- <dt>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">TypeError</span>
- </dd>
- </dl>
- </dt>
- </dl>
-
-
-
- <h5>Returns:</h5>
-
-
- <div class="param-desc">
- 1 if itemA is greater that itemB, 0 if the are equal, and -1 if itemA is less than itemB
- </div>
-
-
-
- </dd>
- </dl>
-
-
-
- </article>
- </section>
- </div>
- <div class="clearfix"></div>
- <footer>
-
-
- <span class="jsdoc-message">
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
- on Sun Oct 13 2013 11:36:44 GMT-0500 (CDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
- </span>
- </footer>
- </div>
-
- <div class="span3">
- <div id="toc"></div>
- </div>
-
- <br clear="both">
- </div>
- </div>
- <script src="scripts/sunlight.js"></script>
- <script src="scripts/sunlight.javascript.js"></script>
- <script src="scripts/sunlight-plugin.doclinks.js"></script>
- <script src="scripts/sunlight-plugin.linenumbers.js"></script>
- <script src="scripts/sunlight-plugin.menu.js"></script>
- <script src="scripts/jquery.min.js"></script>
- <script src="scripts/jquery.scrollTo.js"></script>
- <script src="scripts/jquery.localScroll.js"></script>
- <script src="scripts/bootstrap-dropdown.js"></script>
- <script src="scripts/toc.js"></script>
- <script> Sunlight.highlightAll({lineNumbers:, showMenu: true, enableDoclinks :true}); </script>
- <script>
- $( function () {
- $( "#toc" ).toc( {
- selectors : "h1,h2,h3,h4",
- showAndHide : false,
- scrollTo : 60
- } );
- $( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
- $( "#main span[id^='toc']" ).addClass( "toc-shim" );
- } );
- </script>
-
- </body>
- </html>