kitejs/io.github.yuroyami.kitejs.api/JsValue

JsValue

value class JsValue

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

The asX readers coerce the way JavaScript does, so asString() on the number 5 gives "5", the same answer String(5) gives in a script. Use type first when you need the exact kind.

Types

Companion

object Companion

Properties

isNull

val isNull: Boolean

isNullish

val isNullish: Boolean

True for null and undefined, the two values optional chaining stops at.

isThenable

val JsValue.isThenable: Boolean

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

isUndefined

val isUndefined: Boolean

type

val type: JsType

Which kind of value this is.

typeOf

val typeOf: String

What the typeof operator answers for this value.

Functions

asArray

fun asArray(): JsArray

asArrayOrNull

fun asArrayOrNull(): JsArray?

asBigInt

fun asBigInt(): KBigInt

Throws unless this really is a BigInt. There is no coercion from a number, as in a script.

asBoolean

fun asBoolean(): Boolean

asDouble

fun asDouble(): Double

asFunction

fun asFunction(): JsFunction

asFunctionOrNull

fun asFunctionOrNull(): JsFunction?

asInt

fun asInt(): Int

asLong

fun asLong(): Long

asObject

fun asObject(): JsObject

asObjectOrNull

fun asObjectOrNull(): JsObject?

asString

fun asString(): String

convertTo

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

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

toKotlin

fun toKotlin(): Any?

A plain Kotlin value, all the way down: Map for an object, List for an array, Double, String, Boolean, or null. A function stays a JsFunction, since it has no Kotlin twin.

toString

open override fun toString(): String