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 --- api/pl.treksoft.kvision/-application/-init-.html | 15 +++++ api/pl.treksoft.kvision/-application/dispose.html | 17 +++++ api/pl.treksoft.kvision/-application/index.html | 78 ++++++++++++++++++++++ api/pl.treksoft.kvision/-application/start.html | 21 ++++++ api/pl.treksoft.kvision/-hot/accept.html | 18 +++++ api/pl.treksoft.kvision/-hot/data.html | 14 ++++ api/pl.treksoft.kvision/-hot/dispose.html | 14 ++++ api/pl.treksoft.kvision/-hot/index.html | 61 +++++++++++++++++ api/pl.treksoft.kvision/-k-v-manager.html | 28 ++++++++ api/pl.treksoft.kvision/-module/hot.html | 14 ++++ api/pl.treksoft.kvision/-module/index.html | 40 +++++++++++ api/pl.treksoft.kvision/index.html | 81 +++++++++++++++++++++++ api/pl.treksoft.kvision/module.html | 15 +++++ api/pl.treksoft.kvision/start-application.html | 15 +++++ 14 files changed, 431 insertions(+) create mode 100644 api/pl.treksoft.kvision/-application/-init-.html create mode 100644 api/pl.treksoft.kvision/-application/dispose.html create mode 100644 api/pl.treksoft.kvision/-application/index.html create mode 100644 api/pl.treksoft.kvision/-application/start.html create mode 100644 api/pl.treksoft.kvision/-hot/accept.html create mode 100644 api/pl.treksoft.kvision/-hot/data.html create mode 100644 api/pl.treksoft.kvision/-hot/dispose.html create mode 100644 api/pl.treksoft.kvision/-hot/index.html create mode 100644 api/pl.treksoft.kvision/-k-v-manager.html create mode 100644 api/pl.treksoft.kvision/-module/hot.html create mode 100644 api/pl.treksoft.kvision/-module/index.html create mode 100644 api/pl.treksoft.kvision/index.html create mode 100644 api/pl.treksoft.kvision/module.html create mode 100644 api/pl.treksoft.kvision/start-application.html (limited to 'api/pl.treksoft.kvision') diff --git a/api/pl.treksoft.kvision/-application/-init-.html b/api/pl.treksoft.kvision/-application/-init-.html new file mode 100644 index 00000000..1426c1af --- /dev/null +++ b/api/pl.treksoft.kvision/-application/-init-.html @@ -0,0 +1,15 @@ + + + +Application.<init> - kvision + + + +kvision / pl.treksoft.kvision / Application / <init>
+
+

<init>

+ +Application() +

Base class for KVision applications.

+ + diff --git a/api/pl.treksoft.kvision/-application/dispose.html b/api/pl.treksoft.kvision/-application/dispose.html new file mode 100644 index 00000000..8d5f7549 --- /dev/null +++ b/api/pl.treksoft.kvision/-application/dispose.html @@ -0,0 +1,17 @@ + + + +Application.dispose - kvision + + + +kvision / pl.treksoft.kvision / Application / dispose
+
+

dispose

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

Ending point for an application.

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

+ + diff --git a/api/pl.treksoft.kvision/-application/index.html b/api/pl.treksoft.kvision/-application/index.html new file mode 100644 index 00000000..ab4ea5cc --- /dev/null +++ b/api/pl.treksoft.kvision/-application/index.html @@ -0,0 +1,78 @@ + + + +Application - kvision + + + +kvision / pl.treksoft.kvision / Application
+
+

Application

+abstract class Application +

Base class for KVision applications.

Constructors

+ + + + + + + +

<init>

+Application() +

Base class for KVision applications.

Functions

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

dispose

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

Ending point for an application.

start

+open fun start(): Unit +

Starting point for an application.

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

Starting point for an application with the state managed by Hot Module Replacement (HMR).

Extension Functions

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

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

root

+fun Application.root(id: String, fixed: Boolean = false, init: Root.() -> Unit): Root +

Create new Root container based on ID

+fun Application.root(element: <ERROR CLASS>, fixed: Boolean = false, init: Root.() -> Unit): Root +

Create new Root container based on HTML element

+ + diff --git a/api/pl.treksoft.kvision/-application/start.html b/api/pl.treksoft.kvision/-application/start.html new file mode 100644 index 00000000..5b925e6e --- /dev/null +++ b/api/pl.treksoft.kvision/-application/start.html @@ -0,0 +1,21 @@ + + + +Application.start - kvision + + + +kvision / pl.treksoft.kvision / Application / start
+
+

start

+ +open fun start(): Unit +

Starting point for an application.

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

Starting point for an application with the state managed by Hot Module Replacement (HMR).

Parameters

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

+ + diff --git a/api/pl.treksoft.kvision/-hot/accept.html b/api/pl.treksoft.kvision/-hot/accept.html new file mode 100644 index 00000000..7810e714 --- /dev/null +++ b/api/pl.treksoft.kvision/-hot/accept.html @@ -0,0 +1,18 @@ + + + +Hot.accept - kvision + + + +kvision / pl.treksoft.kvision / 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/api/pl.treksoft.kvision/-hot/data.html b/api/pl.treksoft.kvision/-hot/data.html new file mode 100644 index 00000000..8e830acf --- /dev/null +++ b/api/pl.treksoft.kvision/-hot/data.html @@ -0,0 +1,14 @@ + + + +Hot.data - kvision + + + +kvision / pl.treksoft.kvision / Hot / data
+
+

data

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

dispose

+ +abstract fun dispose(callback: (dynamic) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision/-hot/index.html b/api/pl.treksoft.kvision/-hot/index.html new file mode 100644 index 00000000..713e469f --- /dev/null +++ b/api/pl.treksoft.kvision/-hot/index.html @@ -0,0 +1,61 @@ + + + +Hot - kvision + + + +kvision / pl.treksoft.kvision / 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`

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision/-k-v-manager.html b/api/pl.treksoft.kvision/-k-v-manager.html new file mode 100644 index 00000000..904f8621 --- /dev/null +++ b/api/pl.treksoft.kvision/-k-v-manager.html @@ -0,0 +1,28 @@ + + + +KVManager - kvision + + + +kvision / pl.treksoft.kvision / KVManager
+
+

KVManager

+object KVManager +

Internal singleton object which initializes and configures KVision framework.

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

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

hot

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

Module

+external interface Module +

Helper interface for Hot Module Replacement (HMR).

Properties

+ + + + + + + +

hot

+abstract val hot: Hot?

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision/index.html b/api/pl.treksoft.kvision/index.html new file mode 100644 index 00000000..4cb3dff7 --- /dev/null +++ b/api/pl.treksoft.kvision/index.html @@ -0,0 +1,81 @@ + + + +pl.treksoft.kvision - kvision + + + +kvision / pl.treksoft.kvision
+
+

Package pl.treksoft.kvision

Types

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

+ Application +	+`abstract class Application` + Base class for KVision applications. +
+ Hot +	+`external interface Hot` + Helper interface for Hot Module Replacement (HMR). +
+ KVManager +	+`object KVManager` + Internal singleton object which initializes and configures KVision framework. +
+ Module +	+`external interface Module` + Helper interface for Hot Module Replacement (HMR). +

Properties

+ + + + + + + +

module

+external val module: Module +

Helper variable for Hot Module Replacement (HMR).

Functions

+ + + + + + + +

startApplication

+fun startApplication(builder: () -> Application): Unit +

Main function for creating KVision applications.

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

module

+ +external val module: Module +

Helper variable for Hot Module Replacement (HMR).

+ + diff --git a/api/pl.treksoft.kvision/start-application.html b/api/pl.treksoft.kvision/start-application.html new file mode 100644 index 00000000..f2e31212 --- /dev/null +++ b/api/pl.treksoft.kvision/start-application.html @@ -0,0 +1,15 @@ + + + +startApplication - kvision + + + +kvision / pl.treksoft.kvision / startApplication
+
+

startApplication

+ +fun startApplication(builder: () -> Application): Unit +

Main function for creating KVision applications.

+ + -- cgit