kitejs/io.github.yuroyami.kitejs.api/JsObject

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.

Inheritors

JsArray

JsFunction

Properties

keys

val keys: List<String>

The object's own enumerable string keys, in the order a script would see them.

value

val value: JsValue

The value this wrapper holds, for handing back to the engine.

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.

call

fun call(name: String, vararg args: Any?): JsValue

Calls a method on this object, the way obj.name(...) does in a script.

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.

delete

fun delete(name: String)

equals

open operator override fun equals(other: Any?): Boolean

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.

get

operator fun get(index: Int): JsValue

operator fun get(name: String): JsValue

getter

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

A property computed on every read.

has

fun has(name: String): Boolean

hashCode

open override fun hashCode(): Int

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.

obj

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

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

property

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

Puts a value on the object.

set

operator fun set(index: Int, value: Any?)

operator fun set(name: String, value: Any?)

setter

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

A property that only accepts writes.

toMap

fun toMap(): Map<String, Any?>

A plain Kotlin map, all the way down. Cycles come back as the JsObject that closed them.

toString

open override fun toString(): String