From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-application-base/-init-.html | 16 ++++++ .../-application-base/dispose.html | 17 +++++++ .../-application-base/index.html | 52 +++++++++++++++++++ .../-application-base/start.html | 18 +++++++ docs/api/pl.treksoft.kvision.hmr/-hot/accept.html | 18 +++++++ docs/api/pl.treksoft.kvision.hmr/-hot/data.html | 14 +++++ docs/api/pl.treksoft.kvision.hmr/-hot/dispose.html | 14 +++++ docs/api/pl.treksoft.kvision.hmr/-hot/index.html | 47 +++++++++++++++++ docs/api/pl.treksoft.kvision.hmr/-module/hot.html | 14 +++++ .../api/pl.treksoft.kvision.hmr/-module/index.html | 26 ++++++++++ docs/api/pl.treksoft.kvision.hmr/index.html | 59 ++++++++++++++++++++++ docs/api/pl.treksoft.kvision.hmr/module.html | 15 ++++++ 12 files changed, 310 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.hmr/-application-base/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-application-base/dispose.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-application-base/index.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-application-base/start.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-hot/accept.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-hot/data.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-hot/dispose.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-hot/index.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-module/hot.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/-module/index.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/index.html create mode 100644 docs/api/pl.treksoft.kvision.hmr/module.html (limited to 'docs/api/pl.treksoft.kvision.hmr') diff --git a/docs/api/pl.treksoft.kvision.hmr/-application-base/-init-.html b/docs/api/pl.treksoft.kvision.hmr/-application-base/-init-.html new file mode 100644 index 00000000..2cf4c471 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-application-base/-init-.html @@ -0,0 +1,16 @@ + + + +ApplicationBase.<init> - kvision + + + +kvision / pl.treksoft.kvision.hmr / ApplicationBase / <init>
+
+

<init>

+ +ApplicationBase() +

Base class for applications.

Base class for applications supporting Hot Module Replacement (HMR).

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/-application-base/dispose.html b/docs/api/pl.treksoft.kvision.hmr/-application-base/dispose.html new file mode 100644 index 00000000..f8902380 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-application-base/dispose.html @@ -0,0 +1,17 @@ + + + +ApplicationBase.dispose - kvision + + + +kvision / pl.treksoft.kvision.hmr / ApplicationBase / dispose
+
+

dispose

+ +abstract fun dispose(): Map<String, Any> +

Ending point for an application.

Return
+final state for Hot Module Replacement (HMR).

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/-application-base/index.html b/docs/api/pl.treksoft.kvision.hmr/-application-base/index.html new file mode 100644 index 00000000..4131de12 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-application-base/index.html @@ -0,0 +1,52 @@ + + + +ApplicationBase - kvision + + + +kvision / pl.treksoft.kvision.hmr / ApplicationBase
+
+

ApplicationBase

+abstract class ApplicationBase +

Base class for applications.

Base class for applications supporting Hot Module Replacement (HMR).

Constructors

+ + + + + + + +

<init>

+ApplicationBase() +

Base class for applications.

Functions

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

+ dispose +	+`abstract fun dispose(): Map<String, Any>` + Ending point for an application. +
+ start +	+`abstract fun start(state: Map<String, Any>): Unit` + Starting point for an application. +

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/-application-base/start.html b/docs/api/pl.treksoft.kvision.hmr/-application-base/start.html new file mode 100644 index 00000000..8cbfa395 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-application-base/start.html @@ -0,0 +1,18 @@ + + + +ApplicationBase.start - kvision + + + +kvision / pl.treksoft.kvision.hmr / ApplicationBase / start
+
+

start

+ +abstract fun start(state: Map<String, Any>): Unit +

Starting point for an application.

Parameters

+state - Initial state between Hot Module Replacement (HMR).

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/-hot/accept.html b/docs/api/pl.treksoft.kvision.hmr/-hot/accept.html new file mode 100644 index 00000000..218ff720 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-hot/accept.html @@ -0,0 +1,18 @@ + + + +Hot.accept - kvision + + + +kvision / pl.treksoft.kvision.hmr / Hot / accept
+
+

accept

+ +abstract fun accept(): Unit
+ +abstract fun accept(dependency: String, callback: () -> Unit): Unit
+ +abstract fun accept(dependencies: Array<String>, callback: (updated: Array<String>) -> Unit): Unit + + diff --git a/docs/api/pl.treksoft.kvision.hmr/-hot/data.html b/docs/api/pl.treksoft.kvision.hmr/-hot/data.html new file mode 100644 index 00000000..c9783bf7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-hot/data.html @@ -0,0 +1,14 @@ + + + +Hot.data - kvision + + + +kvision / pl.treksoft.kvision.hmr / Hot / data
+
+

data

+ +abstract val data: dynamic + + diff --git a/docs/api/pl.treksoft.kvision.hmr/-hot/dispose.html b/docs/api/pl.treksoft.kvision.hmr/-hot/dispose.html new file mode 100644 index 00000000..154fd5ce --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-hot/dispose.html @@ -0,0 +1,14 @@ + + + +Hot.dispose - kvision + + + +kvision / pl.treksoft.kvision.hmr / Hot / dispose
+
+

dispose

+ +abstract fun dispose(callback: (dynamic) -> Unit): Unit + + diff --git a/docs/api/pl.treksoft.kvision.hmr/-hot/index.html b/docs/api/pl.treksoft.kvision.hmr/-hot/index.html new file mode 100644 index 00000000..75b15c36 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-hot/index.html @@ -0,0 +1,47 @@ + + + +Hot - kvision + + + +kvision / pl.treksoft.kvision.hmr / Hot
+
+

Hot

+external interface Hot +

Helper interface for Hot Module Replacement (HMR).

Properties

+ + + + + + + +

data

+abstract val data: dynamic

Functions

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

+ accept +	+`abstract fun accept(): Unit` +`abstract fun accept(dependency: String, callback: () -> Unit): Unit` +`abstract fun accept(dependencies: Array<String>, callback: (updated: Array<String>) -> Unit): Unit`
+ dispose +	+`abstract fun dispose(callback: (dynamic) -> Unit): Unit`

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/-module/hot.html b/docs/api/pl.treksoft.kvision.hmr/-module/hot.html new file mode 100644 index 00000000..410cd073 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-module/hot.html @@ -0,0 +1,14 @@ + + + +Module.hot - kvision + + + +kvision / pl.treksoft.kvision.hmr / Module / hot
+
+

hot

+ +abstract val hot: Hot? + + diff --git a/docs/api/pl.treksoft.kvision.hmr/-module/index.html b/docs/api/pl.treksoft.kvision.hmr/-module/index.html new file mode 100644 index 00000000..a1cb37f9 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/-module/index.html @@ -0,0 +1,26 @@ + + + +Module - kvision + + + +kvision / pl.treksoft.kvision.hmr / Module
+
+

Module

+external interface Module +

Helper interface for Hot Module Replacement (HMR).

Properties

+ + + + + + + +

hot

+abstract val hot: Hot?

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/index.html b/docs/api/pl.treksoft.kvision.hmr/index.html new file mode 100644 index 00000000..b322f684 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/index.html @@ -0,0 +1,59 @@ + + + +pl.treksoft.kvision.hmr - kvision + + + +kvision / pl.treksoft.kvision.hmr
+
+

Package pl.treksoft.kvision.hmr

Helper interfaces and classes necessary to develop applications supporting Hot Module Replacement (HMR).

Types

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

+ ApplicationBase +	+`abstract class ApplicationBase` + Base class for applications. +
+ Hot +	+`external interface Hot` + Helper interface for Hot Module Replacement (HMR). +
+ Module +	+`external interface Module` + Helper interface for Hot Module Replacement (HMR). +

Properties

+ + + + + + + +

module

+external val module: Module +

Helper variable for Hot Module Replacement (HMR).

+ + diff --git a/docs/api/pl.treksoft.kvision.hmr/module.html b/docs/api/pl.treksoft.kvision.hmr/module.html new file mode 100644 index 00000000..57d3ced1 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.hmr/module.html @@ -0,0 +1,15 @@ + + + +module - kvision + + + +kvision / pl.treksoft.kvision.hmr / module
+
+

module

+ +external val module: Module +

Helper variable for Hot Module Replacement (HMR).

+ + -- cgit