MyApi.utils.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>MyApi.utils</title>
  7. <!--[if lt IE 9]>
  8. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  9. <![endif]-->
  10. <link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
  11. <link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
  12. <link type="text/css" rel="stylesheet" href="css/prism.min.css">
  13. <link type="text/css" rel="stylesheet" href="css/template.min.css">
  14. <script type="text/javascript">
  15. window.TEMPLATE_OPTIONS = {"includeDate":true,"dateFormat":"Do MMM YYYY","systemName":"FooDoc","systemSummary":"A Bootstrap and Handlebars based template for JSDoc3.","systemLogo":"","systemColor":"","navMembers":[{"kind":"class","title":"Classes","summary":"All documented classes."},{"kind":"external","title":"Externals","summary":"All documented external members."},{"kind":"global","title":"Globals","summary":"All documented globals."},{"kind":"mixin","title":"Mixins","summary":"All documented mixins."},{"kind":"interface","title":"Interfaces","summary":"All documented interfaces."},{"kind":"module","title":"Modules","summary":"All documented modules."},{"kind":"namespace","title":"Namespaces","summary":"All documented namespaces."},{"kind":"tutorial","title":"Tutorials","summary":"All available tutorials."}],"footer":"","copyright":"FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.","linenums":true,"collapseSymbols":true,"inverseNav":true,"inlineNav":false,"outputSourceFiles":true,"sourceRootPath":null,"disablePackagePath":true,"outputSourcePath":false,"showTableOfContents":true,"showAccessFilter":true,"analytics":null,"methodHeadingReturns":true,"sort":"linenum, longname, version, since","search":true,"favicon":null,"stylesheets":[],"scripts":[],"monospaceLinks":false,"cleverLinks":false};
  16. window.DOCLET_TOC_ENABLED = true;
  17. window.DOCLET_AFILTER_ENABLED = false;
  18. </script>
  19. </head>
  20. <body>
  21. <!-- start:navbar.hbs -->
  22. <header class="navbar navbar-default navbar-fixed-top navbar-inverse">
  23. <div class="container">
  24. <div class="navbar-header">
  25. <a class="navbar-brand" href="index.html">
  26. FooDoc
  27. </a>
  28. <!-- displayed on small devices -->
  29. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. </div>
  35. <div class="navbar-collapse collapse" id="topNavigation">
  36. <ul class="nav navbar-nav">
  37. <li class="dropdown">
  38. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
  39. <ul class="dropdown-menu">
  40. <li><a href="global.html#SomeType">SomeType</a></li>
  41. </ul>
  42. </li>
  43. <li class="dropdown">
  44. <a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  45. <ul class="dropdown-menu">
  46. <li><a href="CustomError.html">CustomError</a></li>
  47. <li><a href="GlobalClass.html">GlobalClass</a></li>
  48. <li><a href="MyApi.Child.html">MyApi.Child</a></li>
  49. <li><a href="MyApi.Class.html">MyApi.Class</a></li>
  50. </ul>
  51. </li>
  52. <li class="dropdown">
  53. <a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  54. <ul class="dropdown-menu">
  55. <li><a href="MyApi.html">MyApi</a></li>
  56. <li><a href="MyApi.utils.html">MyApi.utils</a></li>
  57. </ul>
  58. </li>
  59. <li class="dropdown">
  60. <a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
  61. <ul class="dropdown-menu">
  62. <li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
  63. <li><a href="tutorial-drive-car.html">Drive Car</a></li>
  64. </ul>
  65. </li>
  66. </ul>
  67. <!-- start:lunr-search-navbar.hbs -->
  68. <form class="navbar-form navbar-right" role="search">
  69. <div class="input-group">
  70. <input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
  71. <div class="input-group-btn">
  72. <button class="btn btn-default" id="lunr-search-submit">
  73. <i class="glyphicon glyphicon-search"></i>
  74. </button>
  75. </div>
  76. </div>
  77. </form>
  78. <!-- start:lunr-search-navbar.hbs --> </div>
  79. </div>
  80. </header>
  81. <!-- end:navbar.hbs --> <div class="page-header">
  82. <div class="container">
  83. <span class="kind">namespace</span>
  84. <h1><span class="ancestors"><a href="MyApi.html">MyApi</a>.</span><span class="name">utils</span></h1>
  85. <div class="summary"><p>This is to test child namespaces.</p></div> </div>
  86. </div>
  87. <div class="container content">
  88. <div class="row">
  89. <div class="col-md-9 main-content">
  90. <ol class="breadcrumb">
  91. <li><a href="index.html">Home</a></li>
  92. <li><a href="list_namespace.html">Namespaces</a></li>
  93. <li class="active"><a href="MyApi.html">MyApi</a>.utils</li>
  94. </ol>
  95. <section>
  96. <dl class="symbol primary">
  97. <dt class="symbol-title namespace collapsible-symbol expanded">
  98. <h2 class="namespace"><span class="name">utils</span></h2>
  99. <div class="summary"><p>This is to test child namespaces.</p></div></dt>
  100. <dd class="symbol-details namespace collapsible-symbol expanded" style="max-height: 9999px;">
  101. <div class="symbol-details-inner">
  102. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  103. <!-- source -->
  104. <div class="form-group">
  105. <label class="col-sm-3 control-label">Source</label>
  106. <div class="col-sm-9">
  107. <p class="form-control-static"><a href="MyApi.utils.js.html">MyApi.utils.js</a>, <a href="MyApi.utils.js.html#line-1">line 1</a></p>
  108. </div>
  109. </div>
  110. </form>
  111. </div> </div>
  112. </dd>
  113. </dl>
  114. <article class="secondary">
  115. <h3>Methods</h3>
  116. <dl class="symbol">
  117. <hr/>
  118. <dt class="symbol-title function public collapsible-symbol">
  119. <h4 id=".format" class="function public"><span class="signature-attribs">&lt;static> </span><span class="name">format</span><span class="signature-params">( <span class="signature-param">str</span>, <span class="signature-param">arg</span> [,&nbsp;<span class="signature-param">...argN</span>&nbsp;]&nbsp;)</span><span class="signature-type"> &rarr;&nbsp;{string}</span></h4>
  120. <div class="summary"><p>Formats the supplied <code>str</code> with the given replacement args and there indexes.</p></div></dt>
  121. <dd class="symbol-details function public collapsible-symbol">
  122. <div class="symbol-details-inner">
  123. <div class="callout callout-info">
  124. <h5>Parameters</h5>
  125. <table class="params table table-striped">
  126. <thead>
  127. <tr>
  128. <th>Name</th>
  129. <th>Type</th>
  130. <th>Attributes</th>
  131. <th class="last">Description</th>
  132. </tr>
  133. </thead>
  134. <tbody>
  135. <tr>
  136. <td><code>str</code></td>
  137. <td><span class="param-type">string</span></td>
  138. <td class="attributes"></td>
  139. <td class="last">
  140. <p>The format string.</p>
  141. </td>
  142. </tr>
  143. <tr>
  144. <td><code>arg</code></td>
  145. <td><span class="param-type">*</span></td>
  146. <td class="attributes"></td>
  147. <td class="last">
  148. <p>The first of argument to format into the string.</p>
  149. </td>
  150. </tr>
  151. <tr>
  152. <td><code>argN</code></td>
  153. <td><span class="param-type">*</span></td>
  154. <td class="attributes">&lt;optional&gt;<br/>&lt;repeatable&gt;<br/></td>
  155. <td class="last">
  156. <p>Any number of additional arguments.</p>
  157. </td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. </div>
  162. <div class="callout callout-success"><h5>Returns</h5> <form class="form-horizontal returns">
  163. <div class="form-group">
  164. <label class="col-sm-3 control-label returns-type"><span class="param-type">string</span></label>
  165. <div class="col-sm-9">
  166. <div class="form-control-static returns-description"><p>The given <code>str</code> formatted with the supplied arguments.</p></div>
  167. </div>
  168. </div>
  169. </form>
  170. </div> <div class="callout callout-example"><h5>Examples</h5> <div class="example-caption"><p>Basic usage:</p></div>
  171. <div class="example-code">
  172. <pre class="prettyprint source language-javascript"><code class="language-javascript"> var result &#x3D; MyApi.utils.format( &quot;Hello {0}! My name is {1}.&quot;, &quot;Jill&quot;, &quot;Jack&quot; ); // &#x3D;&gt; &quot;Hello Jill! My name is Jack.&quot;</code></pre>
  173. </div>
  174. </div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  175. <!-- source -->
  176. <div class="form-group">
  177. <label class="col-sm-3 control-label">Source</label>
  178. <div class="col-sm-9">
  179. <p class="form-control-static"><a href="MyApi.utils.js.html">MyApi.utils.js</a>, <a href="MyApi.utils.js.html#line-8">line 8</a></p>
  180. </div>
  181. </div>
  182. </form>
  183. </div> </div>
  184. </dd>
  185. </dl>
  186. </article>
  187. </section>
  188. </div>
  189. <div class="col-md-3 side-content">
  190. <nav class="toc hidden-print hidden-sm hidden-xs"></nav>
  191. </div>
  192. </div>
  193. </div>
  194. <footer>
  195. <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
  196. <div class="generated-by">Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on 1st May 2018 using the <a href="https://github.com/steveush/foodoc">FooDoc template</a>.</div>
  197. </footer>
  198. <script src="js/jquery.min.js"></script>
  199. <script src="js/bootstrap.min.js"></script>
  200. <script src="js/clipboard.min.js"></script>
  201. <script src="js/prism.min.js"></script>
  202. <script src="js/template.min.js"></script>
  203. <!-- start:lunr-search-modal.hbs -->
  204. <div class="modal fade" id="lunr-search-modal">
  205. <div class="modal-dialog">
  206. <div class="modal-content">
  207. <div class="modal-header">
  208. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  209. <h4 class="modal-title">Search results</h4>
  210. </div>
  211. <div class="modal-body" id="lunr-search-body">
  212. </div>
  213. <div class="modal-footer" id="lunr-search-footer">
  214. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  215. </div>
  216. </div><!-- /.modal-content -->
  217. </div><!-- /.modal-dialog -->
  218. </div>
  219. <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
  220. </body>
  221. </html>