From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- api1/pl.treksoft.kvision.redux/index.html | 100 ++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 api1/pl.treksoft.kvision.redux/index.html (limited to 'api1/pl.treksoft.kvision.redux/index.html') 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 @@ + + + +pl.treksoft.kvision.redux - kvision + + + +kvision / pl.treksoft.kvision.redux
+
+

Package pl.treksoft.kvision.redux

+

Predictable state container based on Redux library.

+

Types

+ + + + + + + + + + + + + + + + + + + +
+

RAction

+
+interface RAction
+

ReduxStore

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

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

+
+

StateBinding

+
+class StateBinding<S : Any, A : RAction, CONT : Container, CONTENT> : Widget +

A class which binds the redux store with the given container.

+
+

Updateable

+
+class Updateable<S : Any, CONTENT> +

A helper class for updateable redux content.

+
+

Type Aliases

+ + + + + + + + + + + + + + + + + + + +
+

ActionCreator

+
+typealias ActionCreator<A, S> = (Dispatch<A>, GetState<S>) -> Unit
+

Dispatch

+
+typealias Dispatch<A> = (A) -> Unit
+

GetState

+
+typealias GetState<S> = () -> S
+

ReducerFun

+
+typealias ReducerFun<S, A> = (S, A) -> S
+

Functions

+ + + + + + + +
+

createReduxStore

+
+fun <S : Any, A : RAction> createReduxStore(reducer: ReducerFun<S, A>, initialState: S, vararg middlewares: <ERROR CLASS><S>): ReduxStore<S, A>
+fun <S : Any, A : RAction> createReduxStore(reducer: <ERROR CLASS><S, A>, initialState: S, vararg middlewares: dynamic): ReduxStore<S, A> +

An inline helper function for creating Redux store.

+
+ + -- cgit