global.html 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Global</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Global</h1>
  17. <section>
  18. <header>
  19. <h2></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <dl class="details">
  24. </dl>
  25. </div>
  26. <h3 class="subsection-title">Methods</h3>
  27. <h4 class="name" id="registerMethods"><span class="type-signature"></span>registerMethods<span class="signature">(methods, type<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  28. <div class="description">
  29. This function adds the provided methods to the prototype of the corresponding
  30. typed collection. If no type is passed, the methods are added to
  31. Collection.prototype and are available for all collections.
  32. </div>
  33. <h5>Parameters:</h5>
  34. <table class="params">
  35. <thead>
  36. <tr>
  37. <th>Name</th>
  38. <th>Type</th>
  39. <th>Attributes</th>
  40. <th class="last">Description</th>
  41. </tr>
  42. </thead>
  43. <tbody>
  44. <tr>
  45. <td class="name"><code>methods</code></td>
  46. <td class="type">
  47. <span class="param-type">Object</span>
  48. </td>
  49. <td class="attributes">
  50. </td>
  51. <td class="description last">Methods to add to the prototype</td>
  52. </tr>
  53. <tr>
  54. <td class="name"><code>type</code></td>
  55. <td class="type">
  56. <span class="param-type">Type</span>
  57. </td>
  58. <td class="attributes">
  59. &lt;optional><br>
  60. </td>
  61. <td class="description last">Optional type to add the methods to</td>
  62. </tr>
  63. </tbody>
  64. </table>
  65. <dl class="details">
  66. <dt class="tag-source">Source:</dt>
  67. <dd class="tag-source"><ul class="dummy"><li>
  68. <a href="Collection.js.html">Collection.js</a>, <a href="Collection.js.html#line321">line 321</a>
  69. </li></ul></dd>
  70. </dl>
  71. </article>
  72. </section>
  73. </div>
  74. <nav>
  75. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-jscodeshift.html">jscodeshift</a></li></ul><h3>Externals</h3><ul><li><a href="external-astTypes.html">astTypes</a></li></ul><h3>Classes</h3><ul><li><a href="Collection.html">Collection</a></li></ul><h3>Mixins</h3><ul><li><a href="globalMethods.html">globalMethods</a></li><li><a href="mutationMethods.html">mutationMethods</a></li><li><a href="transformMethods.html">transformMethods</a></li><li><a href="traversalMethods.html">traversalMethods</a></li></ul><h3>Global</h3><ul><li><a href="global.html#registerMethods">registerMethods</a></li></ul>
  76. </nav>
  77. <br class="clear">
  78. <footer>
  79. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.1</a> on Wed Sep 21 2016 16:53:09 GMT-0400 (EDT)
  80. </footer>
  81. <script> prettyPrint(); </script>
  82. <script src="scripts/linenumber.js"> </script>
  83. </body>
  84. </html>