diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.redux/index.html | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.redux/index.html')
| -rw-r--r-- | api1/pl.treksoft.kvision.redux/index.html | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.redux/index.html b/api1/pl.treksoft.kvision.redux/index.html new file mode 100644 index 00000000..6e6e8bb2 --- /dev/null +++ b/api1/pl.treksoft.kvision.redux/index.html @@ -0,0 +1,100 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>pl.treksoft.kvision.redux - kvision</title> +<link rel="stylesheet" href="../../style.css"> +</HEAD> +<BODY> +<a href="../index.html">kvision</a> / <a href="./index.html">pl.treksoft.kvision.redux</a><br/> +<br/> +<h2>Package pl.treksoft.kvision.redux</h2> +<p>Predictable state container based on Redux library.</p> +<h3>Types</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-r-action.html">RAction</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">RAction</span></code></td> +</tr> +<tr> +<td> +<p><a href="-redux-store/index.html">ReduxStore</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">ReduxStore</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">, </span><span class="identifier">A</span> <span class="symbol">:</span> <a href="-r-action.html"><span class="identifier">RAction</span></a><span class="symbol">></span></code> +<p>A class implementing redux pattern backed by the Redux Kotlin library.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-state-binding/index.html">StateBinding</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">StateBinding</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">, </span><span class="identifier">A</span> <span class="symbol">:</span> <a href="-r-action.html"><span class="identifier">RAction</span></a><span class="symbol">, </span><span class="identifier">CONT</span> <span class="symbol">:</span> <a href="../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">, </span><span class="identifier">CONTENT</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>A class which binds the redux store with the given container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-updateable/index.html">Updateable</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">Updateable</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">, </span><span class="identifier">CONTENT</span><span class="symbol">></span></code> +<p>A helper class for updateable redux content.</p> +</td> +</tr> +</tbody> +</table> +<h3>Type Aliases</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-action-creator.html">ActionCreator</a></p> +</td> +<td> +<code><span class="keyword">typealias </span><span class="identifier">ActionCreator</span><span class="symbol"><</span><span class="identifier">A</span><span class="symbol">, </span><span class="identifier">S</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><a href="-dispatch.html"><span class="identifier">Dispatch</span></a><span class="symbol"><</span><a href="-action-creator.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">,</span> <a href="-get-state.html"><span class="identifier">GetState</span></a><span class="symbol"><</span><a href="-action-creator.html#S"><span class="identifier">S</span></a><span class="symbol">></span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-dispatch.html">Dispatch</a></p> +</td> +<td> +<code><span class="keyword">typealias </span><span class="identifier">Dispatch</span><span class="symbol"><</span><span class="identifier">A</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><a href="-dispatch.html#A"><span class="identifier">A</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-get-state.html">GetState</a></p> +</td> +<td> +<code><span class="keyword">typealias </span><span class="identifier">GetState</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="-get-state.html#S"><span class="identifier">S</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="-reducer-fun.html">ReducerFun</a></p> +</td> +<td> +<code><span class="keyword">typealias </span><span class="identifier">ReducerFun</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">, </span><span class="identifier">A</span><span class="symbol">></span> <span class="symbol">=</span> <span class="symbol">(</span><a href="-reducer-fun.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="-reducer-fun.html#A"><span class="identifier">A</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="-reducer-fun.html#S"><span class="identifier">S</span></a></code></td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="create-redux-store.html">createReduxStore</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">, </span><span class="identifier">A</span> <span class="symbol">:</span> <a href="-r-action.html"><span class="identifier">RAction</span></a><span class="symbol">></span> <span class="identifier">createReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(kotlin.Function2((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A, )), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.createReduxStore.S)))))/reducer">reducer</span><span class="symbol">:</span> <a href="-reducer-fun.html"><span class="identifier">ReducerFun</span></a><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(kotlin.Function2((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A, )), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.createReduxStore.S)))))/initialState">initialState</span><span class="symbol">:</span> <a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(kotlin.Function2((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A, )), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.createReduxStore.S)))))/middlewares">middlewares</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span></code><br/> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">, </span><span class="identifier">A</span> <span class="symbol">:</span> <a href="-r-action.html"><span class="identifier">RAction</span></a><span class="symbol">></span> <span class="identifier">createReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux$createReduxStore(((pl.treksoft.kvision.redux.createReduxStore.S, pl.treksoft.kvision.redux.createReduxStore.A)), pl.treksoft.kvision.redux.createReduxStore.S, kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="-redux-store/index.html"><span class="identifier">ReduxStore</span></a><span class="symbol"><</span><a href="create-redux-store.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="create-redux-store.html#A"><span class="identifier">A</span></a><span class="symbol">></span></code> +<p>An inline helper function for creating Redux store.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |