mutationMethods.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Mixin: mutationMethods</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">Mixin: mutationMethods</h1>
  17. <section>
  18. <header>
  19. <h2>mutationMethods</h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <dl class="details">
  24. <dt class="tag-source">Source:</dt>
  25. <dd class="tag-source"><ul class="dummy"><li>
  26. <a href="collections_Node.js.html">collections/Node.js</a>, <a href="collections_Node.js.html#line132">line 132</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Methods</h3>
  31. <h4 class="name" id=".insertAfter"><span class="type-signature">(static) </span>insertAfter<span class="signature">(insert)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  32. <div class="description">
  33. Inserts a new node after the current one.
  34. </div>
  35. <h5>Parameters:</h5>
  36. <table class="params">
  37. <thead>
  38. <tr>
  39. <th>Name</th>
  40. <th>Type</th>
  41. <th class="last">Description</th>
  42. </tr>
  43. </thead>
  44. <tbody>
  45. <tr>
  46. <td class="name"><code>insert</code></td>
  47. <td class="type">
  48. <span class="param-type">Node</span>
  49. |
  50. <span class="param-type">Array.&lt;Node></span>
  51. |
  52. <span class="param-type">function</span>
  53. </td>
  54. <td class="description last"></td>
  55. </tr>
  56. </tbody>
  57. </table>
  58. <dl class="details">
  59. <dt class="tag-source">Source:</dt>
  60. <dd class="tag-source"><ul class="dummy"><li>
  61. <a href="collections_Node.js.html">collections/Node.js</a>, <a href="collections_Node.js.html#line169">line 169</a>
  62. </li></ul></dd>
  63. </dl>
  64. <h5>Returns:</h5>
  65. <dl>
  66. <dt>
  67. Type
  68. </dt>
  69. <dd>
  70. <span class="param-type"><a href="Collection.html">Collection</a></span>
  71. </dd>
  72. </dl>
  73. <h4 class="name" id=".insertBefore"><span class="type-signature">(static) </span>insertBefore<span class="signature">(insert)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  74. <div class="description">
  75. Inserts a new node before the current one.
  76. </div>
  77. <h5>Parameters:</h5>
  78. <table class="params">
  79. <thead>
  80. <tr>
  81. <th>Name</th>
  82. <th>Type</th>
  83. <th class="last">Description</th>
  84. </tr>
  85. </thead>
  86. <tbody>
  87. <tr>
  88. <td class="name"><code>insert</code></td>
  89. <td class="type">
  90. <span class="param-type">Node</span>
  91. |
  92. <span class="param-type">Array.&lt;Node></span>
  93. |
  94. <span class="param-type">function</span>
  95. </td>
  96. <td class="description last"></td>
  97. </tr>
  98. </tbody>
  99. </table>
  100. <dl class="details">
  101. <dt class="tag-source">Source:</dt>
  102. <dd class="tag-source"><ul class="dummy"><li>
  103. <a href="collections_Node.js.html">collections/Node.js</a>, <a href="collections_Node.js.html#line155">line 155</a>
  104. </li></ul></dd>
  105. </dl>
  106. <h5>Returns:</h5>
  107. <dl>
  108. <dt>
  109. Type
  110. </dt>
  111. <dd>
  112. <span class="param-type"><a href="Collection.html">Collection</a></span>
  113. </dd>
  114. </dl>
  115. <h4 class="name" id=".replaceWith"><span class="type-signature">(static) </span>replaceWith<span class="signature">(nodes)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  116. <div class="description">
  117. Simply replaces the selected nodes with the provided node. If a function
  118. is provided it is executed for every node and the node is replaced with the
  119. functions return value.
  120. </div>
  121. <h5>Parameters:</h5>
  122. <table class="params">
  123. <thead>
  124. <tr>
  125. <th>Name</th>
  126. <th>Type</th>
  127. <th class="last">Description</th>
  128. </tr>
  129. </thead>
  130. <tbody>
  131. <tr>
  132. <td class="name"><code>nodes</code></td>
  133. <td class="type">
  134. <span class="param-type">Node</span>
  135. |
  136. <span class="param-type">Array.&lt;Node></span>
  137. |
  138. <span class="param-type">function</span>
  139. </td>
  140. <td class="description last"></td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <dl class="details">
  145. <dt class="tag-source">Source:</dt>
  146. <dd class="tag-source"><ul class="dummy"><li>
  147. <a href="collections_Node.js.html">collections/Node.js</a>, <a href="collections_Node.js.html#line141">line 141</a>
  148. </li></ul></dd>
  149. </dl>
  150. <h5>Returns:</h5>
  151. <dl>
  152. <dt>
  153. Type
  154. </dt>
  155. <dd>
  156. <span class="param-type"><a href="Collection.html">Collection</a></span>
  157. </dd>
  158. </dl>
  159. </article>
  160. </section>
  161. </div>
  162. <nav>
  163. <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>
  164. </nav>
  165. <br class="clear">
  166. <footer>
  167. 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)
  168. </footer>
  169. <script> prettyPrint(); </script>
  170. <script src="scripts/linenumber.js"> </script>
  171. </body>
  172. </html>