Package kotlin.js
Functions and other APIs specific to the JavaScript platform.
Types
Console
Exposes the console API to Kotlin.
interface
Console
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
>
JSON
Exposes the JavaScript JSON object to Kotlin.
object
JSON
Promise
Exposes the JavaScript Promise object to Kotlin.
open
class
Promise
<
out
T
>
RegExp
Exposes the JavaScript RegExp object to Kotlin.
class
RegExp
RegExpMatch
Represents the return value of RegExp.exec .
interface
RegExpMatch
Annotations
EagerInitialization
Forces a top-level property to be initialized eagerly, opposed to lazily on the first access to file and/or property.
annotation
class
EagerInitialization
ExperimentalJsExport
Marks experimental JS export annotations.
annotation
class
ExperimentalJsExport
ExperimentalJsFileName
Marks experimental JsFileName annotation.
annotation
class
ExperimentalJsFileName
ExperimentalJsReflectionCreateInstance
This annotation marks the experimental Kotlin/JS reflection API that allows to create an instance of provided KClass The API can be removed completely in any further release.
annotation
class
ExperimentalJsReflectionCreateInstance
JsExport
Exports top-level declaration on JS platform.
annotation
class
JsExport
JsExternalArgument
When placed on a function parameter, requires the type of the passed argument to be external.
annotation
class
JsExternalArgument
JsExternalInheritorsOnly
When placed on an external interface or class, requires all its child interfaces, classes, and objects to be external as well.
annotation
class
JsExternalInheritorsOnly
JsFileName
Specifies the name of the compiled file produced from the annotated source file instead of the default one.
annotation
class
JsFileName
JsModule
Denotes an
external
declaration that must be imported from native JavaScript library.
annotation
class
JsModule
JsName
Gives a declaration (a function, a property or a class) specific name in JavaScript.
annotation
class
JsName
JsNonModule
Denotes an
external
declaration that can be used without module system.
annotation
class
JsNonModule
JsQualifier
Adds prefix to
external
declarations in a source file.
annotation
class
JsQualifier
nativeGetter
annotation
class
nativeGetter
nativeInvoke
annotation
class
nativeInvoke
nativeSetter
annotation
class
nativeSetter
Properties
console
Exposes the console API to Kotlin.
val
console
:
Console
definedExternally
The property that can be used as a placeholder for statements and values that are defined in JavaScript.
val
definedExternally
:
Nothing
undefined
Exposes the JavaScript undefined property to Kotlin.
val
undefined
:
Nothing
?
Functions
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
?
>
asDynamic
Reinterprets this value as a value of the dynamic type .
fun
Any
?
.
asDynamic
(
)
:
dynamic
dateLocaleOptions
fun
dateLocaleOptions
(
init
:
LocaleOptions
.
(
)
->
Unit
)
:
LocaleOptions
eval
Exposes the JavaScript eval function to Kotlin.
fun
eval
(
expr
:
String
)
:
dynamic
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
?
iterator
Allows to iterate this
dynamic
object in the following cases:
operator
fun
dynamic
.
iterator
(
)
:
Iterator
<
dynamic
>
js
Puts the given piece of a JavaScript code right into the calling function.
The compiler replaces call to
js(...)
code with the string constant provided as a parameter.
fun
js
(
code
:
String
)
:
dynamic
jsTypeOf
Function corresponding to JavaScript's
typeof
operator
fun
jsTypeOf
(
a
:
Any
?
)
:
String
parseFloat
fun
parseFloat
(
s
:
String
,
radix
:
Int
=
definedExternally
)
:
Double
parseInt
fun
parseInt
(
s
:
String
)
:
Int
fun
parseInt
(
s
:
String
,
radix
:
Int
=
definedExternally
)
:
Int
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
(
)
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