global.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  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">Members</h3>
  27. <h4 class="name" id="DATA"><span class="type-signature">(constant) </span>DATA<span class="type-signature"></span></h4>
  28. <div class="description">
  29. DATA is used to illustrate the data sructure of the module. in this example, there is an array of primary data. Every primary data element has an array of secondary data elements.
  30. </div>
  31. <dl class="details">
  32. <dt class="tag-source">Source:</dt>
  33. <dd class="tag-source"><ul class="dummy"><li>
  34. <a href="demo_module_constants.js.html">demo_module/constants.js</a>, <a href="demo_module_constants.js.html#line17">line 17</a>
  35. </li></ul></dd>
  36. </dl>
  37. <h4 class="name" id="NAME"><span class="type-signature">(constant) </span>NAME<span class="type-signature"></span></h4>
  38. <div class="description">
  39. NAME is used to identify the module. It is e.g. used in action creators and reducers. This module is called demo_module.
  40. </div>
  41. <dl class="details">
  42. <dt class="tag-source">Source:</dt>
  43. <dd class="tag-source"><ul class="dummy"><li>
  44. <a href="demo_module_constants.js.html">demo_module/constants.js</a>, <a href="demo_module_constants.js.html#line12">line 12</a>
  45. </li></ul></dd>
  46. </dl>
  47. <h4 class="name" id="primary"><span class="type-signature">(constant) </span>primary<span class="type-signature"></span></h4>
  48. <div class="description">
  49. Initial values for the primary data of the module. It could come from a database, file or any other asynchronous source. Include secondary joins directly as objects into the primary, if they are exclusive to the one primary. This makes access and version tagging easier.
  50. </div>
  51. <dl class="details">
  52. <dt class="tag-source">Source:</dt>
  53. <dd class="tag-source"><ul class="dummy"><li>
  54. <a href="demo_module_initialData.js.html">demo_module/initialData.js</a>, <a href="demo_module_initialData.js.html#line14">line 14</a>
  55. </li></ul></dd>
  56. </dl>
  57. </article>
  58. </section>
  59. </div>
  60. <nav>
  61. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-AutoMate.html">AutoMate</a></li><li><a href="module-demo_module.html">demo_module</a></li><li><a href="module-demo_module_state.html">demo_module/state</a></li><li><a href="module-project.html">project</a></li><li><a href="module-project_components.html">project/components</a></li><li><a href="module-project_state.html">project/state</a></li><li><a href="module-registermap.html">registermap</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DATA">DATA</a></li><li><a href="global.html#NAME">NAME</a></li><li><a href="global.html#primary">primary</a></li></ul>
  62. </nav>
  63. <br class="clear">
  64. <footer>
  65. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Mar 14 2017 18:32:27 GMT+0100 (W. Europe Standard Time)
  66. </footer>
  67. <script> prettyPrint(); </script>
  68. <script src="scripts/linenumber.js"> </script>
  69. </body>
  70. </html>