kvision/io.kvision.utils

Package-level declarations

Interfaces and helper functions for Snabbdom virtual dom implementation and a few useful extension functions.

Types

class Cache<K, V>(capacity: Int = 50)

This is a LRU cache that has no performance impact for cache insertions once the capacity of the cache has been reached. For cache hit, performance is O(1) and for cache eviction, it is O(1).

Intl

external object Intl

KvEvent

external class KvEvent(type: String, eventInitDict: <Error class: unknown class> = definedExternally)

Helper class for defining custom events.

LinkedList

class LinkedList<T>

Node

class Node<T>(var value: T)

Created by gazollajunior on 07/04/16.

NumberFormatOptions

external interface NumberFormatOptions

Options for Intl.NumberFormat

Object

external class Object

JavaScript Object type

Serialization

object Serialization

JSON serialization utility functions

Properties

auto

val auto: <Error class: unknown class><Number, UNIT>

Helper property to describe CSS auto value.

val Number.ch: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS ch units.

val Number.cm: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS cm units.

val Number.em: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS em units.

ENTER_KEY

const val ENTER_KEY: Int = 13

Keycode of the ENTER key.

ESC_KEY

const val ESC_KEY: Int = 27

Keycode of the ESC key.

val Number.in: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS in units.

val Number.mm: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS mm units.

mutableSet

val String.mutableSet: MutableSet<String>

val String?.mutableSet: MutableSet<String>

Utility extension property to generate a mutable set of strings to simplify the notation when using classes parameter.

normal

val normal: <Error class: unknown class><Number, UNIT>

Helper property to describe CSS normal value.

val Number.pc: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS pc units.

perc

val Number.perc: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS percent units.

val Int.pt: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS pt units.

val Int.px: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS px units.

rem

val Number.rem: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS rem units.

set

val String.set: Set<String>

val String?.set: Set<String>

Utility extension property to generate a set of strings to simplify the notation when using classes parameter.

val Number.vh: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS vh units.

vmax

val Number.vmax: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS vmax units.

vmin

val Number.vmin: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS vmin units.

val Number.vw: <Error class: unknown class><Number, UNIT>

Extension property to convert Int to CSS vw units.

Functions

asString

fun <Error class: unknown class><Number, UNIT>.asString(): String

Extension function to convert CssSize to String.

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

deepMerge

fun deepMerge(target: dynamic, source: dynamic): dynamic

Helper function to deeply merge two JS objects.

delete

external fun delete(p: dynamic): Boolean

JavaScript delete operator

fun delete(thing: dynamic, key: String)

A helper function for JavaScript delete operator

event

inline fun <T> SnOn<T>.event(name: String, noinline handler: (<Error class: unknown class>) -> Unit)

Helper function for defining custom event types.

flatMap

inline fun <T, R> <Error class: unknown class><T>.flatMap(block: (T) -> <Error class: unknown class><R>): <Error class: unknown class><R>

Simple flatmap implementation for the Result type

getContent

suspend fun <Error class: unknown class>.getContent(): String

Extension function to get file content.

height

fun <Error class: unknown class>.height(): Int

listOfPairs

fun listOfPairs(vararg params: String): List<<Error class: unknown class><String, String>>

Builds List out of given Strings.

minus

operator fun <Error class: unknown class><Number, UNIT>?.minus(i: Number): <Error class: unknown class><Number, UNIT>

Extension operator to decrease CssSize units.

numberFormat

fun numberFormat(optionsBuilder: NumberFormatOptions.() -> Unit): Intl.NumberFormat

fun numberFormat(locales: String, optionsBuilder: NumberFormatOptions.() -> Unit): Intl.NumberFormat

obj

inline fun <T> obj(init: T.() -> Unit): T

Helper function for creating JavaScript objects with given type.

inline fun obj(init: dynamic.() -> Unit): dynamic

Helper function for creating JavaScript objects.

offsetHeight

fun <Error class: unknown class>.offsetHeight(): Int

offsetLeft

fun <Error class: unknown class>.offsetLeft(): Int

offsetTop

fun <Error class: unknown class>.offsetTop(): Int

offsetWidth

fun <Error class: unknown class>.offsetWidth(): Int

pairs

fun List<String>.pairs(): List<<Error class: unknown class><String, String>>

Utility extension function to convert List into List.

plus

operator fun <Error class: unknown class><Number, UNIT>?.plus(i: Number): <Error class: unknown class><Number, UNIT>

Extension operator to increase CssSize units.

snAttrs

inline fun snAttrs(pairs: List<<Error class: unknown class><String, String>>): Attrs

Helper function for creating attributes parameters for Snabbdom.

inline fun snAttrs(pairs: Map<String, String>): Attrs

snClasses

inline fun snClasses(classes: Iterable<String>): Classes

inline fun snClasses(pairs: List<<Error class: unknown class><String, Boolean>>): Classes

Helper function for creating classes parameters for Snabbdom.

snOpt

inline fun snOpt(noinline block: VNodeData.() -> Unit): <Error class: unknown class>

Helper function for creating object parameters for Snabbdom.

snProps

inline fun snProps(pairs: List<<Error class: unknown class><String, String>>): Props

Helper function for creating properties parameters for Snabbdom.

snStyle

inline fun snStyle(pairs: List<<Error class: unknown class><String, String>>): VNodeStyle

Helper function for creating style parameters for Snabbdom.

syncWithList

fun <T> MutableList<T>.syncWithList(list: List<T>)

Utility extension function to synchronise elements of the MutableList.

toCamelCase

fun String.toCamelCase(): String

Utility extension function to convert string from kebab-case to camelCase.

toFixedNoRound

fun Number.toFixedNoRound(precision: Int): String

Formats a number to fixed decimal digits without rounding.

toggle

fun <Error class: unknown class>.toggle()

toHexString

fun Int.toHexString(): String

Extension function to convert Int to hex format.

width

fun <Error class: unknown class>.width(): Int