kitejs/io.github.yuroyami.kitejs.api

Package-level declarations

Types

AsmReport

class AsmReport

What the engine did with one function whose body starts with "use asm".

BindScope

class BindScope<T : Any>

What bind gives you: a place to name the members a script should see.

ConsoleLevel

typealias ConsoleLevel = NativeConsole.Level

How loud a console message is.

ConsoleMessage

data class ConsoleMessage(val level: ConsoleLevel, val text: String)

One console message, already formatted.

ConsolePrinter

typealias ConsolePrinter = NativeConsole.ConsolePrinter

Where console.log and its neighbours end up.

ConsolePrinters

object ConsolePrinters

Printers you probably want.

Converters

object Converters

The fixed table between Kotlin values and engine values. Nothing here uses reflection, so it works the same on every target.

JsArray

class JsArray : JsObject

A JavaScript array seen from Kotlin.

JsEngineError

class JsEngineError : JsException

The engine itself could not go on: it is closed, misused, or out of budget.

JsError

class JsError : JsException

A script threw. value is whatever it threw, which is usually an Error but need not be.

JsException

sealed class JsException : RuntimeException

Anything the facade throws. Every case is one of the three below.

JsFunction

class JsFunction : JsObject

A JavaScript function seen from Kotlin.

JsObject

open class JsObject

A JavaScript object seen from Kotlin. Reading and writing goes straight through to the engine, so a change here is a change the script sees.

JsPromiseHandle

class JsPromiseHandle

A promise the host controls: hand promise to the script, settle it when you are ready.

JsScript

class JsScript

A parsed script, ready to run more than once.

JsStackFrame

data class JsStackFrame(val functionName: String?, val fileName: String?, val lineNumber: Int)

One frame of a script's own call stack.

JsSyntaxError

class JsSyntaxError : JsException

The source did not parse.

JsType

enum JsType : Enum<JsType>

What a JsValue holds. A when over this covers every JavaScript value, so the compiler can tell you when you have missed one.

JsValue

@JvmInline

value class JsValue

One value from the engine. It costs nothing at runtime: the wrapper disappears and only the value itself is passed around.

KiteJs

class KiteJs : AutoCloseable

An engine and the global scope that goes with it. One instance belongs to one thread.

KiteJsConfig

class KiteJsConfig

How to build an engine. Everything has a working default.

LanguageVersion

enum LanguageVersion : Enum<LanguageVersion>

Which JavaScript the engine speaks.

PropertyFlags

class PropertyFlags(val writable: Boolean = true, val enumerable: Boolean = true, val configurable: Boolean = true)

How a property behaves. The defaults match what obj.x = 1 gives you in a script.

Properties

isThenable

val JsValue.isThenable: Boolean

True when this value is thenable, which is what await looks for.

Functions

accessor

fun JsObject.accessor(name: String, flags: PropertyFlags = PropertyFlags(), read: () -> Any?, write: (JsValue) -> Unit)

A property with both halves.

bind

fun <T : Any> JsObject.bind(name: String, instance: T, build: BindScope<T>.() -> Unit): JsObject

Binds a Kotlin object into a fresh JavaScript object.

constant

fun JsObject.constant(name: String, value: Any?)

Puts a value that a script can read but not change.

constructor

fun JsObject.constructor(name: String, arity: Int = 0, flags: PropertyFlags = PropertyFlags(enumerable = false), build: (JsObject, List<JsValue>) -> Unit): JsFunction

A host constructor, callable with new. build fills in the object it is given.

convertTo

inline fun <T> JsValue.convertTo(): T

Reads a JsValue as T, coercing the way JavaScript would where that makes sense.

function

inline fun <A, R> JsObject.function(name: String, crossinline body: (A) -> R): JsFunction

A one-argument host function, with the argument and the answer converted for you.

inline fun <A, B, R> JsObject.function(name: String, crossinline body: (A, B) -> R): JsFunction

A two-argument host function.

inline fun <A, B, C, R> JsObject.function(name: String, crossinline body: (A, B, C) -> R): JsFunction

A three-argument host function.

fun JsObject.function(name: String, arity: Int = 0, flags: PropertyFlags = PropertyFlags(enumerable = false), body: (List<JsValue>) -> Any?): JsFunction

A host function that takes the arguments as they came.

getter

fun JsObject.getter(name: String, flags: PropertyFlags = PropertyFlags(), read: () -> Any?)

A property computed on every read.

KiteJs

fun KiteJs(configure: KiteJsConfig.() -> Unit = {}): KiteJs

Builds an engine. See KiteJsConfig for what you can set.

method

fun JsObject.method(name: String, arity: Int = 0, flags: PropertyFlags = PropertyFlags(enumerable = false), body: (self: JsValue, args: List<JsValue>) -> Any?): JsFunction

A host function that also wants the this it was called on.

newPromise

fun KiteJs.newPromise(): JsPromiseHandle

A promise the host settles later.

obj

fun JsObject.obj(name: String, build: JsObject.() -> Unit = {}): JsObject

A nested object, built by build. Returns it so you can keep a handle.

onSettled

fun KiteJs.onSettled(value: JsValue, onSettled: (JsValue, JsValue?) -> Unit): Boolean

Registers onSettled on a promise. It is called with the value and a null error on success, or with undefined and the reason on failure. Returns false if the value was not thenable at all.

property

fun JsObject.property(name: String, value: Any?, flags: PropertyFlags = PropertyFlags())

Puts a value on the object.

setter

fun JsObject.setter(name: String, flags: PropertyFlags = PropertyFlags(), write: (JsValue) -> Unit)

A property that only accepts writes.