kitejs/io.github.yuroyami.kitejs.api/KiteJs

KiteJs

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

KiteJs { languageVersion = LanguageVersion.ES6 }.use { js ->
    js.global.function("shout") { args -> args.first().asString().uppercase() }
    println(js.evaluate("shout('hi')").asString())   // HI
}

Types

Companion

object Companion

Properties

asmReports

val asmReports: List<AsmReport>

One entry per "use asm" function the engine has parsed, in the order it met them.

global

val global: JsObject

The global object. Bind host functions and values onto it.

version

val version: String

The engine's version string.

Functions

open override fun close()

Releases the engine. Using it afterwards throws.

compile

fun compile(source: String, fileName: String = "<script>"): JsScript

Parses source once so it can be run many times.

evaluate

fun evaluate(source: String, fileName: String = "<eval>"): JsValue

Parses and runs source. The answer is the last expression's value.

newArray

fun newArray(vararg elements: Any?): JsArray

A fresh array holding elements.

newObject

fun newObject(): JsObject

A fresh empty object, the same as {} in a script.

newPromise

fun KiteJs.newPromise(): JsPromiseHandle

A promise the host settles later.

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.

runMicrotasks

fun runMicrotasks()

Runs whatever the promise callbacks have queued. Evaluating already drains the queue at the end of the call, so this is only for work queued from a host callback afterwards.

valueOf

fun valueOf(value: Any?): JsValue

A Kotlin value as the engine sees it, collections and all.