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 --- .../-observable-state/index.html | 74 ++++++++++++++++++++++ .../-observable-state/subscribe.html | 15 +++++ 2 files changed, 89 insertions(+) create mode 100644 api/pl.treksoft.kvision.state/-observable-state/index.html create mode 100644 api/pl.treksoft.kvision.state/-observable-state/subscribe.html (limited to 'api/pl.treksoft.kvision.state/-observable-state') diff --git a/api/pl.treksoft.kvision.state/-observable-state/index.html b/api/pl.treksoft.kvision.state/-observable-state/index.html new file mode 100644 index 00000000..da229c82 --- /dev/null +++ b/api/pl.treksoft.kvision.state/-observable-state/index.html @@ -0,0 +1,74 @@ + + + +ObservableState - kvision + + + +kvision / pl.treksoft.kvision.state / ObservableState
+
+

ObservableState

+interface ObservableState<S> +

An interface of observable state.

Functions

+ + + + + + + +

+abstract fun subscribe(observer: (S) -> Unit): () -> Unit +

Subscribe for the state change notifications.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

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

+ ObservableList +	+`interface ObservableList<T> : MutableList<T>, ObservableState<List<T>>` + Observable list interface. +
+ ObservableListWrapper +	+`class ObservableListWrapper<T> : MutableList<T>, ObservableList<T>, ObservableState<List<T>>` + Simple observable list implementation. +
+ ReduxStore +	+`class ReduxStore<S : Any, A : RAction> : ObservableState<S>` + A class implementing redux pattern backed by the Redux Kotlin library. +

+ + diff --git a/api/pl.treksoft.kvision.state/-observable-state/subscribe.html b/api/pl.treksoft.kvision.state/-observable-state/subscribe.html new file mode 100644 index 00000000..66514b8f --- /dev/null +++ b/api/pl.treksoft.kvision.state/-observable-state/subscribe.html @@ -0,0 +1,15 @@ + + + +ObservableState.subscribe - kvision + + + +kvision / pl.treksoft.kvision.state / ObservableState / subscribe
+
+

+ +abstract fun subscribe(observer: (S) -> Unit): () -> Unit +

Subscribe for the state change notifications.

+ + -- cgit