globalMethods.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Mixin: globalMethods</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: globalMethods</h1>
  17. <section>
  18. <header>
  19. <h2>globalMethods</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_VariableDeclarator.js.html">collections/VariableDeclarator.js</a>, <a href="collections_VariableDeclarator.js.html#line28">line 28</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Methods</h3>
  31. <h4 class="name" id=".findJSXElements"><span class="type-signature">(static) </span>findJSXElements<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  32. <div class="description">
  33. Finds all JSXElements optionally filtered by name
  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>name</code></td>
  47. <td class="type">
  48. <span class="param-type">string</span>
  49. </td>
  50. <td class="description last"></td>
  51. </tr>
  52. </tbody>
  53. </table>
  54. <dl class="details">
  55. <dt class="tag-source">Source:</dt>
  56. <dd class="tag-source"><ul class="dummy"><li>
  57. <a href="collections_JSXElement.js.html">collections/JSXElement.js</a>, <a href="collections_JSXElement.js.html#line37">line 37</a>
  58. </li></ul></dd>
  59. </dl>
  60. <h5>Returns:</h5>
  61. <dl>
  62. <dt>
  63. Type
  64. </dt>
  65. <dd>
  66. <span class="param-type"><a href="Collection.html">Collection</a></span>
  67. </dd>
  68. </dl>
  69. <h4 class="name" id=".findJSXElementsByModuleName"><span class="type-signature">(static) </span>findJSXElementsByModuleName<span class="signature">()</span><span class="type-signature"></span></h4>
  70. <div class="description">
  71. Finds all JSXElements by module name. Given
  72. var Bar = require('Foo');
  73. <Bar />
  74. findJSXElementsByModuleName('Foo') will find <Bar />, without having to
  75. know the variable name.
  76. </div>
  77. <dl class="details">
  78. <dt class="tag-source">Source:</dt>
  79. <dd class="tag-source"><ul class="dummy"><li>
  80. <a href="collections_JSXElement.js.html">collections/JSXElement.js</a>, <a href="collections_JSXElement.js.html#line51">line 51</a>
  81. </li></ul></dd>
  82. </dl>
  83. <h4 class="name" id=".findVariableDeclarators"><span class="type-signature">(static) </span>findVariableDeclarators<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  84. <div class="description">
  85. Finds all variable declarators, optionally filtered by name.
  86. </div>
  87. <h5>Parameters:</h5>
  88. <table class="params">
  89. <thead>
  90. <tr>
  91. <th>Name</th>
  92. <th>Type</th>
  93. <th class="last">Description</th>
  94. </tr>
  95. </thead>
  96. <tbody>
  97. <tr>
  98. <td class="name"><code>name</code></td>
  99. <td class="type">
  100. <span class="param-type">string</span>
  101. </td>
  102. <td class="description last"></td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. <dl class="details">
  107. <dt class="tag-source">Source:</dt>
  108. <dd class="tag-source"><ul class="dummy"><li>
  109. <a href="collections_VariableDeclarator.js.html">collections/VariableDeclarator.js</a>, <a href="collections_VariableDeclarator.js.html#line35">line 35</a>
  110. </li></ul></dd>
  111. </dl>
  112. <h5>Returns:</h5>
  113. <dl>
  114. <dt>
  115. Type
  116. </dt>
  117. <dd>
  118. <span class="param-type"><a href="Collection.html">Collection</a></span>
  119. </dd>
  120. </dl>
  121. </article>
  122. </section>
  123. <section>
  124. <header>
  125. <h2>globalMethods</h2>
  126. </header>
  127. <article>
  128. <div class="container-overview">
  129. <div class="description">Contains filter methods and mutation methods for processing JSXElements.</div>
  130. <dl class="details">
  131. <dt class="tag-source">Source:</dt>
  132. <dd class="tag-source"><ul class="dummy"><li>
  133. <a href="collections_JSXElement.js.html">collections/JSXElement.js</a>, <a href="collections_JSXElement.js.html#line30">line 30</a>
  134. </li></ul></dd>
  135. </dl>
  136. </div>
  137. <h3 class="subsection-title">Methods</h3>
  138. <h4 class="name" id=".findJSXElements"><span class="type-signature">(static) </span>findJSXElements<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  139. <div class="description">
  140. Finds all JSXElements optionally filtered by name
  141. </div>
  142. <h5>Parameters:</h5>
  143. <table class="params">
  144. <thead>
  145. <tr>
  146. <th>Name</th>
  147. <th>Type</th>
  148. <th class="last">Description</th>
  149. </tr>
  150. </thead>
  151. <tbody>
  152. <tr>
  153. <td class="name"><code>name</code></td>
  154. <td class="type">
  155. <span class="param-type">string</span>
  156. </td>
  157. <td class="description last"></td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <dl class="details">
  162. <dt class="tag-source">Source:</dt>
  163. <dd class="tag-source"><ul class="dummy"><li>
  164. <a href="collections_JSXElement.js.html">collections/JSXElement.js</a>, <a href="collections_JSXElement.js.html#line37">line 37</a>
  165. </li></ul></dd>
  166. </dl>
  167. <h5>Returns:</h5>
  168. <dl>
  169. <dt>
  170. Type
  171. </dt>
  172. <dd>
  173. <span class="param-type"><a href="Collection.html">Collection</a></span>
  174. </dd>
  175. </dl>
  176. <h4 class="name" id=".findJSXElementsByModuleName"><span class="type-signature">(static) </span>findJSXElementsByModuleName<span class="signature">()</span><span class="type-signature"></span></h4>
  177. <div class="description">
  178. Finds all JSXElements by module name. Given
  179. var Bar = require('Foo');
  180. <Bar />
  181. findJSXElementsByModuleName('Foo') will find <Bar />, without having to
  182. know the variable name.
  183. </div>
  184. <dl class="details">
  185. <dt class="tag-source">Source:</dt>
  186. <dd class="tag-source"><ul class="dummy"><li>
  187. <a href="collections_JSXElement.js.html">collections/JSXElement.js</a>, <a href="collections_JSXElement.js.html#line51">line 51</a>
  188. </li></ul></dd>
  189. </dl>
  190. <h4 class="name" id=".findVariableDeclarators"><span class="type-signature">(static) </span>findVariableDeclarators<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Collection.html">Collection</a>}</span></h4>
  191. <div class="description">
  192. Finds all variable declarators, optionally filtered by name.
  193. </div>
  194. <h5>Parameters:</h5>
  195. <table class="params">
  196. <thead>
  197. <tr>
  198. <th>Name</th>
  199. <th>Type</th>
  200. <th class="last">Description</th>
  201. </tr>
  202. </thead>
  203. <tbody>
  204. <tr>
  205. <td class="name"><code>name</code></td>
  206. <td class="type">
  207. <span class="param-type">string</span>
  208. </td>
  209. <td class="description last"></td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <dl class="details">
  214. <dt class="tag-source">Source:</dt>
  215. <dd class="tag-source"><ul class="dummy"><li>
  216. <a href="collections_VariableDeclarator.js.html">collections/VariableDeclarator.js</a>, <a href="collections_VariableDeclarator.js.html#line35">line 35</a>
  217. </li></ul></dd>
  218. </dl>
  219. <h5>Returns:</h5>
  220. <dl>
  221. <dt>
  222. Type
  223. </dt>
  224. <dd>
  225. <span class="param-type"><a href="Collection.html">Collection</a></span>
  226. </dd>
  227. </dl>
  228. </article>
  229. </section>
  230. </div>
  231. <nav>
  232. <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>
  233. </nav>
  234. <br class="clear">
  235. <footer>
  236. 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)
  237. </footer>
  238. <script> prettyPrint(); </script>
  239. <script src="scripts/linenumber.js"> </script>
  240. </body>
  241. </html>