From 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Tue, 24 Sep 2019 15:44:15 +0200 Subject: API documentation for KVision 0.0.39 --- api/pl.treksoft.kvision.redux/-redux-store/-init-.html | 16 ++++++++++++++++ api/pl.treksoft.kvision.redux/-redux-store/dispatch.html | 8 +++++--- api/pl.treksoft.kvision.redux/-redux-store/index.html | 10 ++++++---- 3 files changed, 27 insertions(+), 7 deletions(-) (limited to 'api/pl.treksoft.kvision.redux/-redux-store') 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 @@ kvision / pl.treksoft.kvision.redux / ReduxStore / <init>

<init>

+ +ReduxStore(reducer: ReducerFun<S, A>, initialState: S, vararg middlewares: <ERROR CLASS><S>) +

Creates a Redux store with given reducer function and initial state.

+

Parameters

+

+S - redux state type

+

+A - redux action type

+

+reducer - a reducer function

+

+initialState - an initial state

+

+middlewares - a list of optional Redux Kotlin middlewares

+

Constructor
+Creates a Redux store with given reducer function and initial state.

ReduxStore(reducer: <ERROR CLASS><S, A>, initialState: S, vararg middlewares: dynamic)

Creates a Redux store with given reducer function and initial state.

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 @@

dispatch

-fun dispatch(action: A): <ERROR CLASS> +fun dispatch(action: A): Unit

Dispatches a synchronous action object.

- -fun dispatch(actionCreator: ActionCreator<dynamic, S>): <ERROR CLASS> + +fun dispatch(actionCreator: ActionCreator<A, S>): Unit
+ +fun dispatch(actionCreator: ActionCreator<dynamic, S>): <ERROR CLASS>

Dispatches an asynchronous action function.

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 @@ kvision / pl.treksoft.kvision.redux / ReduxStore

ReduxStore

-class ReduxStore<S : Any, A> -

A class implementing redux pattern backed by the original Redux JS library.

+class ReduxStore<S : Any, A : RAction> +

A class implementing redux pattern backed by the Redux Kotlin library.

Constructors

@@ -18,6 +18,7 @@

<init>

@@ -32,9 +33,10 @@

dispatch

-- cgit
+ReduxStore(reducer: ReducerFun<S, A>, initialState: S, vararg middlewares: <ERROR CLASS><S>)
ReduxStore(reducer: <ERROR CLASS><S, A>, initialState: S, vararg middlewares: dynamic)

Creates a Redux store with given reducer function and initial state.

 -fun dispatch(action: A): <ERROR CLASS> +fun dispatch(action: A): Unit

Dispatches a synchronous action object.

-fun dispatch(actionCreator: ActionCreator<dynamic, S>): <ERROR CLASS> +fun dispatch(actionCreator: ActionCreator<A, S>): Unit
+fun dispatch(actionCreator: ActionCreator<dynamic, S>): <ERROR CLASS>

Dispatches an asynchronous action function.