diff options
author | Robert Jaros <rjaros@finn.pl> | 2019-06-23 14:12:10 +0200 |
---|---|---|
committer | Robert Jaros <rjaros@finn.pl> | 2019-06-23 14:12:10 +0200 |
commit | bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b (patch) | |
tree | 5fe76e243d94095bf2368122acb21db84a693aef /api/pl.treksoft.kvision.redux/-redux-store | |
parent | a8ff23c5e58394c21e2e7c2a4880302b43b60dfd (diff) | |
download | kvision-bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b.tar.gz kvision-bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b.tar.bz2 kvision-bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b.zip |
API documentation for KVision 0.0.37
Diffstat (limited to 'api/pl.treksoft.kvision.redux/-redux-store')
3 files changed, 5 insertions, 37 deletions
diff --git a/api/pl.treksoft.kvision.redux/-redux-store/-init-.html b/api/pl.treksoft.kvision.redux/-redux-store/-init-.html index c119ddfc..c6d3d906 100644 --- a/api/pl.treksoft.kvision.redux/-redux-store/-init-.html +++ b/api/pl.treksoft.kvision.redux/-redux-store/-init-.html @@ -8,20 +8,18 @@ <a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="index.html">ReduxStore</a> / <a href="./-init-.html"><init></a><br/> <br/> <h1><init></h1> -<a name="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))"></a> -<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/stateSerializer">stateSerializer</span><span class="symbol">:</span> <span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span></code> +<a name="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))"></a> +<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="index.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.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span></code> <p>Creates a Redux store with given reducer function and initial state.</p> <h3>Parameters</h3> <p><a name="S"></a> -<code>S</code> - redux state type (@Serializable)</p> +<code>S</code> - redux state type</p> <p><a name="A"></a> <code>A</code> - redux action type</p> <p><a name="reducer"></a> <code>reducer</code> - a reducer function</p> <p><a name="initialState"></a> <code>initialState</code> - an initial state</p> -<p><a name="stateSerializer"></a> -<code>stateSerializer</code> - a serializer for the state type</p> <p><a name="middlewares"></a> <code>middlewares</code> - a list of optional Redux JS middlewares</p> <p><strong>Constructor</strong><br/> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/index.html b/api/pl.treksoft.kvision.redux/-redux-store/index.html index 71c5567f..82f9cfa0 100644 --- a/api/pl.treksoft.kvision.redux/-redux-store/index.html +++ b/api/pl.treksoft.kvision.redux/-redux-store/index.html @@ -9,8 +9,7 @@ <br/> <h1>ReduxStore</h1> <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></code> -<p>A class implementing redux pattern backed by the original Redux JS library. -It requires @Serializable state.</p> +<p>A class implementing redux pattern backed by the original Redux JS library.</p> <h3>Constructors</h3> <table> <tbody> @@ -19,26 +18,12 @@ It requires @Serializable state.</p> <p><a href="-init-.html"><init></a></p> </td> <td> -<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/stateSerializer">stateSerializer</span><span class="symbol">:</span> <span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlinx.serialization.KSerializer((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span></code> +<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))/reducer">reducer</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">,</span> <a href="index.html#A"><span class="identifier">A</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))/initialState">initialState</span><span class="symbol">:</span> <a href="index.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.ReduxStore$<init>(((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A)), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((kotlin.Any)))/middlewares">middlewares</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span></code> <p>Creates a Redux store with given reducer function and initial state.</p> </td> </tr> </tbody> </table> -<h3>Properties</h3> -<table> -<tbody> -<tr> -<td> -<p><a href="state-serializer.html">stateSerializer</a></p> -</td> -<td> -<code><span class="keyword">val </span><span class="identifier">stateSerializer</span><span class="symbol">: </span><span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span></code> -<p>a serializer for the state type</p> -</td> -</tr> -</tbody> -</table> <h3>Functions</h3> <table> <tbody> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/state-serializer.html b/api/pl.treksoft.kvision.redux/-redux-store/state-serializer.html deleted file mode 100644 index ea96ec0c..00000000 --- a/api/pl.treksoft.kvision.redux/-redux-store/state-serializer.html +++ /dev/null @@ -1,15 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>ReduxStore.stateSerializer - 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> / <a href="index.html">ReduxStore</a> / <a href="./state-serializer.html">stateSerializer</a><br/> -<br/> -<h1>stateSerializer</h1> -<a name="pl.treksoft.kvision.redux.ReduxStore$stateSerializer"></a> -<code><span class="keyword">val </span><span class="identifier">stateSerializer</span><span class="symbol">: </span><span class="identifier">KSerializer</span><span class="symbol"><</span><a href="index.html#S"><span class="identifier">S</span></a><span class="symbol">></span></code> -<p>a serializer for the state type</p> -</BODY> -</HTML> |