module-registermap.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: registermap</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">Module: registermap</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. </div>
  23. <h3 class="subsection-title">Members</h3>
  24. <h4 class="name" id=".actionTypes"><span class="type-signature">(static, constant) </span>actionTypes<span class="type-signature"></span></h4>
  25. <div class="description">
  26. actionTypes define what actions are handeled by the reducer.
  27. </div>
  28. <dl class="details">
  29. <dt class="tag-source">Source:</dt>
  30. <dd class="tag-source"><ul class="dummy"><li>
  31. <a href="registermap_state.js.html">registermap/state.js</a>, <a href="registermap_state.js.html#line16">line 16</a>
  32. </li></ul></dd>
  33. </dl>
  34. <h4 class="name" id=".sagas"><span class="type-signature">(static, constant) </span>sagas<span class="type-signature"></span></h4>
  35. <div class="description">
  36. sagas are asynchronous workers (JS generators) to handle the state.
  37. // Worker
  38. export function * incrementAsync () {
  39. try {
  40. const data = yield call(Api.isIncrementOk)
  41. yield put({ type: 'INCREMENT_SUCCESS', data })
  42. } catch (error) {
  43. yield put({ type: 'INCREMENT_FAIL', error})
  44. }
  45. }
  46. // Watcher (intercepts INCREMENT_REQUEST, dispatches INCREMENT_SUCCESS or INCREMENT_FAIL in return.)
  47. export function * watchIncrementAsync () {
  48. yield takeEvery('INCREMENT_REQUEST', incrementAsync)
  49. }
  50. // export all sagas in parallel
  51. function * sagas () {
  52. yield takeEvery('INCREMENT_REQUEST')
  53. yield takeEvery('DECREMENT_REQUEST')
  54. }
  55. </div>
  56. <dl class="details">
  57. <dt class="tag-source">Source:</dt>
  58. <dd class="tag-source"><ul class="dummy"><li>
  59. <a href="registermap_state.js.html">registermap/state.js</a>, <a href="registermap_state.js.html#line190">line 190</a>
  60. </li></ul></dd>
  61. </dl>
  62. <h4 class="name" id=".state"><span class="type-signature">(static, constant) </span>state<span class="type-signature"></span></h4>
  63. <div class="description">
  64. state definition
  65. </div>
  66. <dl class="details">
  67. <dt class="tag-source">Source:</dt>
  68. <dd class="tag-source"><ul class="dummy"><li>
  69. <a href="registermap_state.js.html">registermap/state.js</a>, <a href="registermap_state.js.html#line78">line 78</a>
  70. </li></ul></dd>
  71. </dl>
  72. <h3 class="subsection-title">Methods</h3>
  73. <h4 class="name" id="~createSetting"><span class="type-signature">(inner) </span>createSetting<span class="signature">()</span><span class="type-signature"></span></h4>
  74. <div class="description">
  75. actions is an object with references to all action creators
  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="registermap_state.js.html">registermap/state.js</a>, <a href="registermap_state.js.html#line27">line 27</a>
  81. </li></ul></dd>
  82. </dl>
  83. <h4 class="name" id="~registermapSettings"><span class="type-signature">(inner) </span>registermapSettings<span class="signature">()</span><span class="type-signature"></span></h4>
  84. <div class="description">
  85. reducer is called by the redux dispatcher and handles all component actions
  86. </div>
  87. <dl class="details">
  88. <dt class="tag-source">Source:</dt>
  89. <dd class="tag-source"><ul class="dummy"><li>
  90. <a href="registermap_state.js.html">registermap/state.js</a>, <a href="registermap_state.js.html#line84">line 84</a>
  91. </li></ul></dd>
  92. </dl>
  93. </article>
  94. </section>
  95. </div>
  96. <nav>
  97. <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_components_index.html">demo_module/components/index</a></li><li><a href="module-demo_module_constants.html">demo_module/constants</a></li><li><a href="module-demo_module_initialData.html">demo_module/initialData</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>
  98. </nav>
  99. <br class="clear">
  100. <footer>
  101. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Mar 14 2017 18:34:23 GMT+0100 (W. Europe Standard Time)
  102. </footer>
  103. <script> prettyPrint(); </script>
  104. <script src="scripts/linenumber.js"> </script>
  105. </body>
  106. </html>