PageRenderTime 52ms CodeModel.GetById 20ms RepoModel.GetById 1ms app.codeStats 0ms

/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
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation Module: util</title>
  6. <!--[if lt IE 9]>
  7. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  8. <![endif]-->
  9. <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  10. <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
  11. </head>
  12. <body>
  13. <div class="container-fluid">
  14. <div class="navbar navbar-fixed-top ">
  15. <div class="navbar-inner">
  16. <a class="brand" href="index.html">Documentation</a>
  17. <ul class="nav">
  18. <li class="dropdown">
  19. <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
  20. class="caret"></b></a>
  21. <ul class="dropdown-menu ">
  22. <li>
  23. <a href="signals.html">signals</a>
  24. </li>
  25. </ul>
  26. </li>
  27. <li class="dropdown">
  28. <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
  29. class="caret"></b></a>
  30. <ul class="dropdown-menu ">
  31. <li>
  32. <a href="module-accessor.html">accessor</a>
  33. </li>
  34. <li>
  35. <a href="module-analytics.html">analytics</a>
  36. </li>
  37. <li>
  38. <a href="module-array.html">array</a>
  39. </li>
  40. <li>
  41. <a href="module-assets.html">assets</a>
  42. </li>
  43. <li>
  44. <a href="module-class.html">class</a>
  45. </li>
  46. <li>
  47. <a href="module-color.html">color</a>
  48. </li>
  49. <li>
  50. <a href="module-cookie.html">cookie</a>
  51. </li>
  52. <li>
  53. <a href="module-core.html">core</a>
  54. </li>
  55. <li>
  56. <a href="module-date.html">date</a>
  57. </li>
  58. <li>
  59. <a href="module-dom.html">dom</a>
  60. </li>
  61. <li>
  62. <a href="Document.html">dom/Document</a>
  63. </li>
  64. <li>
  65. <a href="Window.html">dom/Window</a>
  66. </li>
  67. <li>
  68. <a href="module-DOMEvent.html">DOMEvent</a>
  69. </li>
  70. <li>
  71. <a href="module-DOMNode.html">DOMNode</a>
  72. </li>
  73. <li>
  74. <a href="module-element.html">element</a>
  75. </li>
  76. <li>
  77. <a href="module-elements.html">elements</a>
  78. </li>
  79. <li>
  80. <a href="module-functools.html">functools</a>
  81. </li>
  82. <li>
  83. <a href="module-iter.html">iter</a>
  84. </li>
  85. <li>
  86. <a href="module-json.html">json</a>
  87. </li>
  88. <li>
  89. <a href="module-log.html">log</a>
  90. </li>
  91. <li>
  92. <a href="module-modernizr.html">modernizr</a>
  93. </li>
  94. <li>
  95. <a href="module-number.html">number</a>
  96. </li>
  97. <li>
  98. <a href="module-object.html">object</a>
  99. </li>
  100. <li>
  101. <a href="module-operator.html">operator</a>
  102. </li>
  103. <li>
  104. <a href="module-request.html">request</a>
  105. </li>
  106. <li>
  107. <a href="module-string.html">string</a>
  108. </li>
  109. <li>
  110. <a href="module-swf.html">swf</a>
  111. </li>
  112. <li>
  113. <a href="module-url.html">url</a>
  114. </li>
  115. <li>
  116. <a href="module-useragent.html">useragent</a>
  117. </li>
  118. <li>
  119. <a href="module-util.html">util</a>
  120. </li>
  121. <li>
  122. <a href="module-XDM.html">XDM</a>
  123. </li>
  124. </ul>
  125. </li>
  126. <li class="dropdown">
  127. <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
  128. class="caret"></b></a>
  129. <ul class="dropdown-menu ">
  130. <li>
  131. <a href="module-assets.CSS.html">CSS</a>
  132. </li>
  133. <li>
  134. <a href="module-assets.IMG.html">IMG</a>
  135. </li>
  136. <li>
  137. <a href="module-assets.JS.html">JS</a>
  138. </li>
  139. <li>
  140. <a href="module-class.Chain.html">Chain</a>
  141. </li>
  142. <li>
  143. <a href="module-class.Class.html">Class</a>
  144. </li>
  145. <li>
  146. <a href="module-class.Events.html">Events</a>
  147. </li>
  148. <li>
  149. <a href="module-class.Interface.html">Interface</a>
  150. </li>
  151. <li>
  152. <a href="module-class.Options.html">Options</a>
  153. </li>
  154. <li>
  155. <a href="module-class.Storage.html">Storage</a>
  156. </li>
  157. <li>
  158. <a href="module-color.Color.html">Color</a>
  159. </li>
  160. <li>
  161. <a href="module-cookie.Cookie.html">Cookie</a>
  162. </li>
  163. <li>
  164. <a href="module-core.BaseRegistry.html">BaseRegistry</a>
  165. </li>
  166. <li>
  167. <a href="module-core.Type.html">Type</a>
  168. </li>
  169. <li>
  170. <a href="module-DOMEvent-Event.html">Event</a>
  171. </li>
  172. <li>
  173. <a href="module-DOMNode.Node.html">Node</a>
  174. </li>
  175. <li>
  176. <a href="module-element.Element.html">Element</a>
  177. </li>
  178. <li>
  179. <a href="module-elements.Elements.html">Elements</a>
  180. </li>
  181. <li>
  182. <a href="module-iter.Iterable.html">Iterable</a>
  183. </li>
  184. <li>
  185. <a href="module-request.JSON.html">JSON</a>
  186. </li>
  187. <li>
  188. <a href="module-request.Request.html">Request</a>
  189. </li>
  190. <li>
  191. <a href="module-request.SIGNED.html">SIGNED</a>
  192. </li>
  193. <li>
  194. <a href="module-swf.Swiff.html">Swiff</a>
  195. </li>
  196. <li>
  197. <a href="module-XDM.Rpc.html">Rpc</a>
  198. </li>
  199. <li>
  200. <a href="module-XDM.Socket.html">Socket</a>
  201. </li>
  202. <li>
  203. <a href="signals.SignalBinding.html">SignalBinding</a>
  204. </li>
  205. </ul>
  206. </li>
  207. <li class="dropdown">
  208. <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b
  209. class="caret"></b></a>
  210. <ul class="dropdown-menu ">
  211. <li>
  212. <a href="global.html#event:failure">failure</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="dropdown">
  217. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
  218. class="caret"></b></a>
  219. <ul class="dropdown-menu ">
  220. <li>
  221. <a href="global.html#hooksOf">hooksOf</a>
  222. </li>
  223. </ul>
  224. </li>
  225. </ul>
  226. </div>
  227. </div>
  228. <div class="row-fluid">
  229. <div class="span8">
  230. <div id="main">
  231. <h1 class="page-title">Module: util</h1>
  232. <section>
  233. <header>
  234. <h2>
  235. util
  236. </h2>
  237. </header>
  238. <article>
  239. <div class="container-overview">
  240. <div class="description">Module for utilities to solve common patterns.</div>
  241. <dl class="details">
  242. <dt class="tag-author">Author:</dt>
  243. <dd class="tag-author">
  244. <ul>
  245. <li>Eric Satterwhite</li>
  246. </ul>
  247. </dd>
  248. <dt class="tag-source">Source:</dt>
  249. <dd class="tag-source"><ul class="dummy"><li>
  250. <a href="util.js.html">v1.0/util.js</a>
  251. </li></ul></dd>
  252. </dl>
  253. </div>
  254. <h3 class="subsection-title">Requires</h3>
  255. <ul>
  256. <li><a href="module-core.html">module:core</a></li>
  257. </ul>
  258. <h3 class="subsection-title">Members</h3>
  259. <dl>
  260. <dt>
  261. <h4 class="name" id="ComparatorRegistry"><span class="type-signature">&lt;static> </span>ComparatorRegistry<span class="type-signature"></span></h4>
  262. </dt>
  263. <dd>
  264. <div class="description">
  265. Holds currently registerd ( arrayLike & dateLike )
  266. </div>
  267. <dl class="details">
  268. <dt class="tag-source">Source:</dt>
  269. <dd class="tag-source"><ul class="dummy"><li>
  270. <a href="util.js.html">v1.0/util.js</a>
  271. </li></ul></dd>
  272. </dl>
  273. </dd>
  274. <dt>
  275. <h4 class="name" id="typeOf"><span class="type-signature">&lt;static> </span>typeOf<span class="type-signature"></span></h4>
  276. </dt>
  277. <dd>
  278. <dl class="details">
  279. <dt class="tag-source">Source:</dt>
  280. <dd class="tag-source"><ul class="dummy"><li>
  281. <a href="util.js.html">v1.0/util.js</a>
  282. </li></ul></dd>
  283. <dt class="tag-see">See:</dt>
  284. <dd class="tag-see">
  285. <ul>
  286. <li><a href="module-core.html#typeOf">module:core.typeOf</a></li>
  287. </ul>
  288. </dd>
  289. </dl>
  290. </dd>
  291. </dl>
  292. <h3 class="subsection-title">Methods</h3>
  293. <dl>
  294. <dt>
  295. <h4 class="name" id="compare"><span class="type-signature">&lt;static> </span>compare<span class="signature">(itemA, itemB)</span><span class="type-signature"></span></h4>
  296. </dt>
  297. <dd>
  298. <div class="description">
  299. Compares object that are difficult to compare, ( arrays, and Dates by default )
  300. </div>
  301. <h5>Parameters:</h5>
  302. <table class="params table table-striped">
  303. <thead>
  304. <tr>
  305. <th>Name</th>
  306. <th>Type</th>
  307. <th class="last">Description</th>
  308. </tr>
  309. </thead>
  310. <tbody>
  311. <tr>
  312. <td class="name"><code>itemA</code></td>
  313. <td class="type">
  314. <span class="param-type">Object</span>
  315. </td>
  316. <td class="description last">An item to compare</td>
  317. </tr>
  318. <tr>
  319. <td class="name"><code>itemB</code></td>
  320. <td class="type">
  321. <span class="param-type">Object</span>
  322. </td>
  323. <td class="description last">An item that is of the same type as itemA</td>
  324. </tr>
  325. </tbody>
  326. </table>
  327. <dl class="details">
  328. <dt class="tag-source">Source:</dt>
  329. <dd class="tag-source"><ul class="dummy"><li>
  330. <a href="util.js.html">v1.0/util.js</a>
  331. </li></ul></dd>
  332. </dl>
  333. <h5>Throws:</h5>
  334. <dl>
  335. <dt>
  336. <div class="param-desc">
  337. If it can not figure out a way to compare the objects
  338. </div>
  339. </dt>
  340. <dt>
  341. <dl>
  342. <dt>
  343. Type
  344. </dt>
  345. <dd>
  346. <span class="param-type">TypeError</span>
  347. </dd>
  348. </dl>
  349. </dt>
  350. </dl>
  351. <h5>Returns:</h5>
  352. <div class="param-desc">
  353. 1 if itemA is greater that itemB, 0 if the are equal, and -1 if itemA is less than itemB
  354. </div>
  355. </dd>
  356. </dl>
  357. </article>
  358. </section>
  359. </div>
  360. <div class="clearfix"></div>
  361. <footer>
  362. <span class="jsdoc-message">
  363. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
  364. on Sun Oct 13 2013 11:36:44 GMT-0500 (CDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
  365. </span>
  366. </footer>
  367. </div>
  368. <div class="span3">
  369. <div id="toc"></div>
  370. </div>
  371. <br clear="both">
  372. </div>
  373. </div>
  374. <script src="scripts/sunlight.js"></script>
  375. <script src="scripts/sunlight.javascript.js"></script>
  376. <script src="scripts/sunlight-plugin.doclinks.js"></script>
  377. <script src="scripts/sunlight-plugin.linenumbers.js"></script>
  378. <script src="scripts/sunlight-plugin.menu.js"></script>
  379. <script src="scripts/jquery.min.js"></script>
  380. <script src="scripts/jquery.scrollTo.js"></script>
  381. <script src="scripts/jquery.localScroll.js"></script>
  382. <script src="scripts/bootstrap-dropdown.js"></script>
  383. <script src="scripts/toc.js"></script>
  384. <script> Sunlight.highlightAll({lineNumbers:, showMenu: true, enableDoclinks :true}); </script>
  385. <script>
  386. $( function () {
  387. $( "#toc" ).toc( {
  388. selectors : "h1,h2,h3,h4",
  389. showAndHide : false,
  390. scrollTo : 60
  391. } );
  392. $( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
  393. $( "#main span[id^='toc']" ).addClass( "toc-shim" );
  394. } );
  395. </script>
  396. </body>
  397. </html>