W3cubDocs

/Kotlin

Package kotlin.js

Functions and other APIs specific to the JavaScript platform.

Types

Platform and version requirements: JS (1.1)

Console

Exposes the console API to Kotlin.

interface Console
Platform and version requirements: JS (1.1)

Date

Exposes the Date API to Kotlin.

class Date
Platform and version requirements: JS (1.1)

JsClass

Represents the constructor of a class. Instances of JsClass can be passed to JavaScript APIs that expect a constructor reference.

interface JsClass<T : Any>
Platform and version requirements: JS (1.1)

Json

An interface for indexing access to a collection of key-value pairs, where type of key is String and type of value is Any?.

interface Json
Platform and version requirements: JS (1.1)

JSON

Exposes the JavaScript JSON object to Kotlin.

object JSON
Platform and version requirements: JS (1.1)

Math

Exposes the JavaScript Math object to Kotlin.

object Math
Platform and version requirements: JS (1.1)

Promise

Exposes the JavaScript Promise object to Kotlin.

open class Promise<out T>
Platform and version requirements: JS (1.1)

RegExp

Exposes the JavaScript RegExp object to Kotlin.

class RegExp
Platform and version requirements: JS (1.1)

RegExpMatch

Represents the return value of RegExp.exec.

interface RegExpMatch

Annotations

Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

ExperimentalJsExport

Marks experimental JS export annotations.

annotation class ExperimentalJsExport
Platform and version requirements: JS (1.3)

JsExport

Exports top-level declaration on JS platform.

annotation class JsExport
Platform and version requirements: JS (1.1)

JsModule

Denotes an external declaration that must be imported from native JavaScript library.

annotation class JsModule
Platform and version requirements: JS (1.0)

JsName

Gives a declaration (a function, a property or a class) specific name in JavaScript.

annotation class JsName
Platform and version requirements: JS (1.1)

JsNonModule

Denotes an external declaration that can be used without module system.

annotation class JsNonModule
Platform and version requirements: JS (1.1)

JsQualifier

Adds prefix to external declarations in a source file.

annotation class JsQualifier
Platform and version requirements: JS (1.1)

nativeGetter

annotation class nativeGetter
Platform and version requirements: JS (1.1)

nativeInvoke

annotation class nativeInvoke
Platform and version requirements: JS (1.1)

nativeSetter

annotation class nativeSetter

Properties

Platform and version requirements: JS (1.1)

console

Exposes the console API to Kotlin.

val console: Console
Platform and version requirements: JS (1.1)

definedExternally

The property that can be used as a placeholder for statements and values that are defined in JavaScript.

val definedExternally: Nothing
Platform and version requirements: JS (1.1)

js

Obtains a constructor reference for the given KClass.

val <T : Any> KClass<T>.js: JsClass<T>
Platform and version requirements: JS (1.1)

kotlin

Obtains a KClass instance for the given constructor reference.

val <T : Any> JsClass<T>.kotlin: KClass<T>
Platform and version requirements: JS (1.1)

noImpl

val noImpl: Nothing
Platform and version requirements: JS (1.1)

undefined

Exposes the JavaScript undefined property to Kotlin.

val undefined: Nothing?

Functions

Platform and version requirements: JS (1.1)

add

Adds key-value pairs from other to this. Returns the original receiver.

fun Json.add(other: Json): Json
Platform and version requirements: JS (1.1)

asArray

Converts the result of RegExp.exec to an array where the first element contains the entire matched text and each subsequent element is the text matched by each capturing parenthesis.

fun RegExpMatch.asArray(): Array<out String?>
Platform and version requirements: JS (1.1)

asDynamic

Reinterprets this value as a value of the dynamic type.

fun Any?.asDynamic(): dynamic
Platform and version requirements: JS (1.1)

dateLocaleOptions

fun dateLocaleOptions(
    init: LocaleOptions.() -> Unit
): LocaleOptions
Platform and version requirements: JS (1.1)

eval

Exposes the JavaScript eval function to Kotlin.

fun eval(expr: String): dynamic
Platform and version requirements: JS (1.1)

get

Returns the entire text matched by RegExp.exec if the index parameter is 0, or the text matched by the capturing parenthesis at the given index.

operator fun RegExpMatch.get(index: Int): String?
Platform and version requirements: JS (1.1)

iterator

Allows to iterate this dynamic object in the following cases:

operator fun dynamic.iterator(): Iterator<dynamic>
Platform and version requirements: JS (1.1)

js

fun js(code: String): dynamic
Platform and version requirements: JS (1.1)

json

Returns a simple JavaScript object (as Json) using provided key-value pairs as names and values of its properties.

fun json(vararg pairs: Pair<String, Any?>): Json
Platform and version requirements: JS (1.1)

jsTypeOf

Function corresponding to JavaScript's typeof operator

fun jsTypeOf(a: Any?): String
Platform and version requirements: JS (1.1)

max

Returns the greater of two values.

fun Math.max(a: Long, b: Long): Long
Platform and version requirements: JS (1.1)

min

Returns the smaller of two values.

fun Math.min(a: Long, b: Long): Long
Platform and version requirements: JS (1.1)

parseFloat

fun parseFloat(
    s: String, 
    radix: Int = definedExternally
): Double
Platform and version requirements: JS (1.1)

parseInt

fun parseInt(s: String): Int
fun parseInt(s: String, radix: Int = definedExternally): Int
Platform and version requirements: JS (1.1)

reset

Resets the regular expression so that subsequent RegExp.test and RegExp.exec calls will match starting with the beginning of the input string.

fun RegExp.reset()
Platform and version requirements: JS (1.1)

then

fun <T, S> Promise<Promise<T>>.then(
    onFulfilled: ((T) -> S)?
): Promise<S>
fun <T, S> Promise<Promise<T>>.then(
    onFulfilled: ((T) -> S)?, 
    onRejected: ((Throwable) -> S)?
): Promise<S>
Platform and version requirements: JS (1.1)

unsafeCast

Reinterprets this value as a value of the specified type T without any actual type checking.

fun <T> Any?.unsafeCast(): T

Reinterprets this dynamic value as a value of the specified type T without any actual type checking.

fun <T> dynamic.unsafeCast(): T

© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.js/index.html