-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
255 changed files
with
559,373 additions
and
8,008 deletions.
There are no files selected for viewing
2,632 changes: 2,632 additions & 0 deletions
2,632
packages/xarc-react-redux/docs/assets/css/main.css
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <!doctype html> | ||
| <html class="default no-js"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <title>@xarc/react-redux</title> | ||
| <meta name="description" content="Documentation for @xarc/react-redux"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <link rel="stylesheet" href="assets/css/main.css"> | ||
| <script async src="assets/js/search.js" id="search-script"></script> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <div class="tsd-page-toolbar"> | ||
| <div class="container"> | ||
| <div class="table-wrap"> | ||
| <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> | ||
| <div class="field"> | ||
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> | ||
| <input id="tsd-search-field" type="text" /> | ||
| </div> | ||
| <ul class="results"> | ||
| <li class="state loading">Preparing search index...</li> | ||
| <li class="state failure">The search index is not available</li> | ||
| </ul> | ||
| <a href="index.html" class="title">@xarc/react-redux</a> | ||
| </div> | ||
| <div class="table-cell" id="tsd-widgets"> | ||
| <div id="tsd-filter"> | ||
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> | ||
| <div class="tsd-filter-group"> | ||
| <div class="tsd-select" id="tsd-filter-visibility"> | ||
| <span class="tsd-select-label">All</span> | ||
| <ul class="tsd-select-list"> | ||
| <li data-value="public">Public</li> | ||
| <li data-value="protected">Public/Protected</li> | ||
| <li data-value="private" class="selected">All</li> | ||
| </ul> | ||
| </div> | ||
| <input type="checkbox" id="tsd-filter-inherited" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> | ||
| <input type="checkbox" id="tsd-filter-externals" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-externals">Externals</label> | ||
| </div> | ||
| </div> | ||
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="tsd-page-title"> | ||
| <div class="container"> | ||
| <h1>@xarc/react-redux</h1> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container container-main"> | ||
| <div class="row"> | ||
| <div class="col-8 col-content"> | ||
| <div class="tsd-panel tsd-typography"> | ||
| <a href="#xarcreact-redux" id="xarcreact-redux" style="color: inherit; text-decoration: none;"> | ||
| <h1><code>@xarc/react-redux</code></h1> | ||
| </a> | ||
| <p>This module is part of the <a href="https://www.electrode.io">Electrode X React Web App platform</a> for using [Redux] in version 2 of its SubApp design.</p> | ||
| </div> | ||
| </div> | ||
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | ||
| <nav class="tsd-navigation primary"> | ||
| <ul> | ||
| <li class=" "> | ||
| <a href="modules.html">Exports</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/browser.html">browser</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/common.html">common</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/common_redux_shared_store.html">common/redux-<wbr>shared-<wbr>store</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/node.html">node</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <nav class="tsd-navigation secondary menu-sticky"> | ||
| <ul class="before-current"> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <footer class="with-border-bottom"> | ||
| <div class="container"> | ||
| <h2>Legend</h2> | ||
| <div class="tsd-legend-group"> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
| <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| <div class="container tsd-generator"> | ||
| <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> | ||
| </div> | ||
| <div class="overlay"></div> | ||
| <script src="assets/js/main.js"></script> | ||
| </body> | ||
| </html> |
284 changes: 284 additions & 0 deletions
284
packages/xarc-react-redux/docs/interfaces/browser.redux.action.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,284 @@ | ||
| <!doctype html> | ||
| <html class="default no-js"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <title>Action | @xarc/react-redux</title> | ||
| <meta name="description" content="Documentation for @xarc/react-redux"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <link rel="stylesheet" href="../assets/css/main.css"> | ||
| <script async src="../assets/js/search.js" id="search-script"></script> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <div class="tsd-page-toolbar"> | ||
| <div class="container"> | ||
| <div class="table-wrap"> | ||
| <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> | ||
| <div class="field"> | ||
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> | ||
| <input id="tsd-search-field" type="text" /> | ||
| </div> | ||
| <ul class="results"> | ||
| <li class="state loading">Preparing search index...</li> | ||
| <li class="state failure">The search index is not available</li> | ||
| </ul> | ||
| <a href="../index.html" class="title">@xarc/react-redux</a> | ||
| </div> | ||
| <div class="table-cell" id="tsd-widgets"> | ||
| <div id="tsd-filter"> | ||
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> | ||
| <div class="tsd-filter-group"> | ||
| <div class="tsd-select" id="tsd-filter-visibility"> | ||
| <span class="tsd-select-label">All</span> | ||
| <ul class="tsd-select-list"> | ||
| <li data-value="public">Public</li> | ||
| <li data-value="protected">Public/Protected</li> | ||
| <li data-value="private" class="selected">All</li> | ||
| </ul> | ||
| </div> | ||
| <input type="checkbox" id="tsd-filter-inherited" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> | ||
| <input type="checkbox" id="tsd-filter-externals" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-externals">Externals</label> | ||
| </div> | ||
| </div> | ||
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="tsd-page-title"> | ||
| <div class="container"> | ||
| <ul class="tsd-breadcrumb"> | ||
| <li> | ||
| <a href="../modules.html">@xarc/react-redux</a> | ||
| </li> | ||
| <li> | ||
| <a href="../modules/browser.html">browser</a> | ||
| </li> | ||
| <li> | ||
| <a href="../modules/browser.redux.html">Redux</a> | ||
| </li> | ||
| <li> | ||
| <a href="browser.redux.action.html">Action</a> | ||
| </li> | ||
| </ul> | ||
| <h1>Interface Action<T></h1> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container container-main"> | ||
| <div class="row"> | ||
| <div class="col-8 col-content"> | ||
| <section class="tsd-panel tsd-comment"> | ||
| <div class="tsd-comment tsd-typography"> | ||
| <div class="lead"> | ||
| <p>An <em>action</em> is a plain object that represents an intention to change the | ||
| state. Actions are the only way to get data into the store. Any data, | ||
| whether from UI events, network callbacks, or other sources such as | ||
| WebSockets needs to eventually be dispatched as actions.</p> | ||
| </div> | ||
| <p>Actions must have a <code>type</code> field that indicates the type of action being | ||
| performed. Types can be defined as constants and imported from another | ||
| module. It's better to use strings for <code>type</code> than Symbols because strings | ||
| are serializable.</p> | ||
| <p>Other than <code>type</code>, the structure of an action object is really up to you. | ||
| If you're interested, check out Flux Standard Action for recommendations on | ||
| how actions should be constructed.</p> | ||
| </div> | ||
| </section> | ||
| <section class="tsd-panel tsd-type-parameters"> | ||
| <h3>Type parameters</h3> | ||
| <ul class="tsd-type-parameters"> | ||
| <li> | ||
| <h4>T = <span class="tsd-signature-type">any</span></h4> | ||
| <div class="tsd-comment tsd-typography"> | ||
| <div class="lead"> | ||
| <p>the type of the action's <code>type</code> tag.</p> | ||
| </div> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| <section class="tsd-panel tsd-hierarchy"> | ||
| <h3>Hierarchy</h3> | ||
| <ul class="tsd-hierarchy"> | ||
| <li> | ||
| <span class="target">Action</span> | ||
| <ul class="tsd-hierarchy"> | ||
| <li> | ||
| <a href="browser.redux.anyaction.html" class="tsd-signature-type" data-tsd-kind="Interface">AnyAction</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| <section class="tsd-panel-group tsd-index-group"> | ||
| <h2>Index</h2> | ||
| <section class="tsd-panel tsd-index-panel"> | ||
| <div class="tsd-index-content"> | ||
| <section class="tsd-index-section tsd-is-external"> | ||
| <h3>Properties</h3> | ||
| <ul class="tsd-index-list"> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="browser.redux.action.html#type" class="tsd-kind-icon">type</a></li> | ||
| </ul> | ||
| </section> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <section class="tsd-panel-group tsd-member-group tsd-is-external"> | ||
| <h2>Properties</h2> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a name="type" class="tsd-anchor"></a> | ||
| <h3>type</h3> | ||
| <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div> | ||
| <aside class="tsd-sources"> | ||
| <ul> | ||
| <li>Defined in node_modules/.f/_/redux/4.0.5/redux/index.d.ts:21</li> | ||
| </ul> | ||
| </aside> | ||
| </section> | ||
| </section> | ||
| </div> | ||
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | ||
| <nav class="tsd-navigation primary"> | ||
| <ul> | ||
| <li class=" "> | ||
| <a href="../modules.html">Exports</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <nav class="tsd-navigation secondary menu-sticky"> | ||
| <ul class="before-current"> | ||
| </ul> | ||
| <ul class="current"> | ||
| <li class="current tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.action.html" class="tsd-kind-icon">Action</a> | ||
| <ul> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> | ||
| <a href="browser.redux.action.html#type" class="tsd-kind-icon">type</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul class="after-current"> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.actioncreator.html" class="tsd-kind-icon">Action<wbr>Creator</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.actioncreatorsmapobject.html" class="tsd-kind-icon">Action<wbr>Creators<wbr>Map<wbr>Object</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-is-external"> | ||
| <a href="browser.redux.anyaction.html" class="tsd-kind-icon">Any<wbr>Action</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.dispatch.html" class="tsd-kind-icon">Dispatch</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.middleware.html" class="tsd-kind-icon">Middleware</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.middlewareapi.html" class="tsd-kind-icon">MiddlewareAPI</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.store.html" class="tsd-kind-icon">Store</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="browser.redux.storecreator.html" class="tsd-kind-icon">Store<wbr>Creator</a> | ||
| </li> | ||
| <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-is-external"> | ||
| <a href="browser.redux.unsubscribe.html" class="tsd-kind-icon">Unsubscribe</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#actionfromreducer" class="tsd-kind-icon">Action<wbr>From<wbr>Reducer</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#actionfromreducersmapobject" class="tsd-kind-icon">Action<wbr>From<wbr>Reducers<wbr>Map<wbr>Object</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#combinedstate" class="tsd-kind-icon">Combined<wbr>State</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#deeppartial" class="tsd-kind-icon">Deep<wbr>Partial</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#func0" class="tsd-kind-icon">Func0</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#func1" class="tsd-kind-icon">Func1</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#func2" class="tsd-kind-icon">Func2</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#func3" class="tsd-kind-icon">Func3</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#observable" class="tsd-kind-icon">Observable</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#observer" class="tsd-kind-icon">Observer</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#preloadedstate" class="tsd-kind-icon">Preloaded<wbr>State</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#reducer" class="tsd-kind-icon">Reducer</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#reducerfromreducersmapobject" class="tsd-kind-icon">Reducer<wbr>From<wbr>Reducers<wbr>Map<wbr>Object</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#reducersmapobject" class="tsd-kind-icon">Reducers<wbr>Map<wbr>Object</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#statefromreducersmapobject" class="tsd-kind-icon">State<wbr>From<wbr>Reducers<wbr>Map<wbr>Object</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#storeenhancer" class="tsd-kind-icon">Store<wbr>Enhancer</a> | ||
| </li> | ||
| <li class=" tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#storeenhancerstorecreator" class="tsd-kind-icon">Store<wbr>Enhancer<wbr>Store<wbr>Creator</a> | ||
| </li> | ||
| <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#_combinedstate" class="tsd-kind-icon">$<wbr>Combined<wbr>State</a> | ||
| </li> | ||
| <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#applymiddleware" class="tsd-kind-icon">apply<wbr>Middleware</a> | ||
| </li> | ||
| <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#bindactioncreators" class="tsd-kind-icon">bind<wbr>Action<wbr>Creators</a> | ||
| </li> | ||
| <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#combinereducers" class="tsd-kind-icon">combine<wbr>Reducers</a> | ||
| </li> | ||
| <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#compose" class="tsd-kind-icon">compose</a> | ||
| </li> | ||
| <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"> | ||
| <a href="../modules/browser.redux.html#createstore" class="tsd-kind-icon">create<wbr>Store</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <footer class="with-border-bottom"> | ||
| <div class="container"> | ||
| <h2>Legend</h2> | ||
| <div class="tsd-legend-group"> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
| <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| <div class="container tsd-generator"> | ||
| <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> | ||
| </div> | ||
| <div class="overlay"></div> | ||
| <script src="../assets/js/main.js"></script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.