diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-09-24 15:44:15 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-09-24 15:44:15 +0200 |
| commit | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (patch) | |
| tree | 0131a68b9382ee36693d327eea2d93ac1f90b770 /api/pl.treksoft.kvision.redux/-redux-store | |
| parent | 2febd99a43e367e7100e9fc21bd6eef1cd1ea47e (diff) | |
| download | kvision-4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17.tar.gz kvision-4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17.tar.bz2 kvision-4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17.zip | |
API documentation for KVision 0.0.39
Diffstat (limited to 'api/pl.treksoft.kvision.redux/-redux-store')
3 files changed, 27 insertions, 7 deletions
diff --git a/api/pl.treksoft.kvision.redux/-redux-store/-init-.html b/api/pl.treksoft.kvision.redux/-redux-store/-init-.html index c6d3d906..7c3181cf 100644 --- a/api/pl.treksoft.kvision.redux/-redux-store/-init-.html +++ b/api/pl.treksoft.kvision.redux/-redux-store/-init-.html @@ -8,6 +8,22 @@ <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>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.S)))))"></a> +<code><span class="identifier">ReduxStore</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$<init>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.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="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>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.S)))))/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>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.S)))))/middlewares">middlewares</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><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</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="middlewares"></a> +<code>middlewares</code> - a list of optional Redux Kotlin middlewares</p> +<p><strong>Constructor</strong><br/> +Creates a Redux store with given reducer function and initial state.</p> <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> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html b/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html index d064b625..808ae649 100644 --- a/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html +++ b/api/pl.treksoft.kvision.redux/-redux-store/dispatch.html @@ -9,10 +9,12 @@ <br/> <h1>dispatch</h1> <a name="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)"></a> -<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)/action">action</span><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"><ERROR CLASS></span></code> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)/action">action</span><span class="symbol">:</span> <a href="index.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> <p>Dispatches a synchronous action object.</p> -<a name="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((kotlin.Any, )), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Unit)))"></a> -<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((kotlin.Any, )), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Unit)))/actionCreator">actionCreator</span><span class="symbol">:</span> <a href="../-action-creator.html"><span class="identifier">ActionCreator</span></a><span class="symbol"><</span><span class="keyword">dynamic</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="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<a name="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.A, kotlin.Unit)), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), )))"></a> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.A, kotlin.Unit)), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), )))/actionCreator">actionCreator</span><span class="symbol">:</span> <a href="../-action-creator.html"><span class="identifier">ActionCreator</span></a><span class="symbol"><</span><a href="index.html#A"><span class="identifier">A</span></a><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="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code><br/> +<a name="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((kotlin.Any, kotlin.Unit)), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), )))"></a> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((kotlin.Any, kotlin.Unit)), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), )))/actionCreator">actionCreator</span><span class="symbol">:</span> <a href="../-action-creator.html"><span class="identifier">ActionCreator</span></a><span class="symbol"><</span><span class="keyword">dynamic</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="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> <p>Dispatches an asynchronous action function.</p> </BODY> </HTML> diff --git a/api/pl.treksoft.kvision.redux/-redux-store/index.html b/api/pl.treksoft.kvision.redux/-redux-store/index.html index 82f9cfa0..12e6bab4 100644 --- a/api/pl.treksoft.kvision.redux/-redux-store/index.html +++ b/api/pl.treksoft.kvision.redux/-redux-store/index.html @@ -8,8 +8,8 @@ <a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.redux</a> / <a href="./index.html">ReduxStore</a><br/> <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.</p> +<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> <h3>Constructors</h3> <table> <tbody> @@ -18,6 +18,7 @@ <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>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.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="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>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.S)))))/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>(kotlin.Function2((pl.treksoft.kvision.redux.ReduxStore.S, pl.treksoft.kvision.redux.ReduxStore.A, )), pl.treksoft.kvision.redux.ReduxStore.S, kotlin.Array((((pl.treksoft.kvision.redux.ReduxStore.S)))))/middlewares">middlewares</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><span class="symbol">)</span></code><br/> <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> @@ -32,9 +33,10 @@ <p><a href="dispatch.html">dispatch</a></p> </td> <td> -<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)/action">action</span><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"><ERROR CLASS></span></code> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(pl.treksoft.kvision.redux.ReduxStore.A)/action">action</span><span class="symbol">:</span> <a href="index.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> <p>Dispatches a synchronous action object.</p> -<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((kotlin.Any, )), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), kotlin.Unit)))/actionCreator">actionCreator</span><span class="symbol">:</span> <a href="../-action-creator.html"><span class="identifier">ActionCreator</span></a><span class="symbol"><</span><span class="keyword">dynamic</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="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((pl.treksoft.kvision.redux.ReduxStore.A, kotlin.Unit)), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), )))/actionCreator">actionCreator</span><span class="symbol">:</span> <a href="../-action-creator.html"><span class="identifier">ActionCreator</span></a><span class="symbol"><</span><a href="index.html#A"><span class="identifier">A</span></a><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="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code><br/> +<code><span class="keyword">fun </span><span class="identifier">dispatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.redux.ReduxStore$dispatch(kotlin.Function2((kotlin.Function1((kotlin.Any, kotlin.Unit)), kotlin.Function0((pl.treksoft.kvision.redux.ReduxStore.S)), )))/actionCreator">actionCreator</span><span class="symbol">:</span> <a href="../-action-creator.html"><span class="identifier">ActionCreator</span></a><span class="symbol"><</span><span class="keyword">dynamic</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="symbol">: </span><span class="identifier"><ERROR CLASS></span></code> <p>Dispatches an asynchronous action function.</p> </td> </tr> |