js - scala.scalajs.js

Types, methods and values for interoperability with JavaScript libraries.

This package is only relevant to the Scala.js compiler, and should not be referenced by any project compiled to the JVM.

Guide

General documentation on Scala.js is available at http://www.scala-js.org/doc/.

Overview

The trait js.Any is the root of the hierarchy of JavaScript types. This package defines important subtypes of js.Any that are defined in the standard library of ECMAScript 5.1 (or ES 6, with a label in the documentation), such as js.Object, js.Array and js.RegExp.

Implicit conversions to and from standard Scala types to their equivalent in JavaScript are provided. For example, from Scala functions to JavaScript functions and back.

The most important subtypes of js.Any declared in this package are:

js.Object, the superclass of most (all) JavaScript classes
js.Array
js.Function (and subtraits with specific number of parameters)
js.ThisFunction and its subtraits for functions that take the JavaScript this as an explicit parameter
js.Dictionary, a Map-like view of the properties of a JS object

The trait js.Dynamic is a special subtrait of js.Any. It can represent any JavaScript value in a dynamically-typed way. It is possible to call any method and read and write any field of a value of type js.Dynamic.

There are no explicit definitions for JavaScript primitive types, as one could expect, because the corresponding Scala types stand in their stead:

Boolean is the type of primitive JavaScript booleans
Double is the type of primitive JavaScript numbers
String is the type of primitive JavaScript strings (or null)
Unit is the type of the JavaScript undefined value
Null is the type of the JavaScript null value

js.UndefOr gives a scala.Option-like interface where the JavaScript value undefined takes the role of None.

A | B is an unboxed pseudo-union type, suitable to type values that admit several unrelated types in facade types.

Linear Supertypes

AnyRef, scala.Any

Type Members

trait Any extends AnyRef

Root of the hierarchy of JavaScript types.
class Array[A] extends Object with Iterable[A]

Arrays are list-like objects whose prototype has methods to perform traversal and mutation operations.
final class ArrayOps[A] extends ArrayLike[A, Array[A]] with Builder[A, Array[A]]

Equivalent of scm.ArrayOps for js.Array.
final class ConstructorTag[T <: Any] extends AnyVal

Stores the JS constructor function of a JS class.
class Date extends Object

Creates a JavaScript Date instance that represents a single moment in time.
sealed trait Dictionary[A] extends Any

Dictionary "view" of a JavaScript value.
sealed trait Dynamic extends Any with scala.Dynamic

Dynamically typed JavaScript value.
class Error extends Object

Annotations
@RawJSType() @native() @JSGlobal()
class EvalError extends Error

An instance representing an error that occurs regarding the global function eval().
class Function extends Object

The Function constructor creates a new Function object.
trait Function0[+R] extends Function

Annotations
@RawJSType() @native()
trait Function1[-T1, +R] extends Function

Annotations
@RawJSType() @native()
trait Function2[-T1, -T2, +R] extends Function

Annotations
@RawJSType() @native()
trait Iterable[+A] extends Object

ECMAScript 6 JavaScript Iterable.
final class IterableOps[+A] extends collection.Iterable[A]

Adapts a JavaScript Iterable to a Scala Iterable
trait Iterator[+A] extends Object

ECMAScript 6 JavaScript Iterator.
trait JSArrayOps[A] extends Object

Discouraged native JavaScript Array methods.
sealed abstract class JSConvertersLowPrioImplicits extends AnyRef
trait JSNumberOps extends Any

Operations on JavaScript numbers.
trait JSStringOps extends Any

Operations on JavaScript strings.
final case class JavaScriptException(exception: scala.Any) extends RuntimeException with Product with Serializable
sealed trait LowPrioAnyImplicits extends LowestPrioAnyImplicits
sealed trait LowestPrioAnyImplicits extends AnyRef
class Object extends Any

Base class of all JavaScript objects.
class Promise[+A] extends Object with Thenable[A]

ECMAScript 6 Promise of an asynchronous result.
trait PropertyDescriptor extends Object

Annotations
@RawJSType()
class RangeError extends Error

An instance representing an error that occurs when a numeric variable or parameter is outside of its valid range.
class ReferenceError extends Error

Represents an error when a non-existent variable is referenced.
class RegExp extends Object

The RegExp constructor creates a regular expression object for matching text with a pattern.
sealed trait Symbol extends Any

ECMAScript 6 JavaScript Symbol.
class SyntaxError extends Error

Represents an error when trying to interpret syntactically invalid code.
trait Thenable[+A] extends Object

A thing on which one can call the then method.
trait ThisFunction extends Function

A JavaScript function where this is considered as a first parameter.
trait ThisFunction0[-T0, +R] extends Function with ThisFunction

Annotations
@RawJSType() @native()
trait ThisFunction1[-T0, -T1, +R] extends Function with ThisFunction

Annotations
@RawJSType() @native()
trait ThisFunction2[-T0, -T1, -T2, +R] extends Function with ThisFunction

Annotations
@RawJSType() @native()
sealed trait Tuple2[+T1, +T2] extends Object

A tuple "view" of 2 elements of a JavaScript js.Array.
sealed trait Tuple3[+T1, +T2, +T3] extends Object

A tuple "view" of 3 elements of a JavaScript js.Array.
class TypeError extends Error

Represents an error when a value is not of the expected type.
class URIError extends Error

Represents an error when a malformed URI is encountered.
type UndefOr[+A] = |[A, Unit]

Value of type A or the JS undefined value.
Value of type A or the JS undefined value.
This type is actually strictly equivalent to A | Unit, since Unit is the type of the undefined value.
js.UndefOr[A] is the type of a value that can be either undefined or an A. It provides an API similar to that of scala.Option through the UndefOrOps implicit class, where undefined take the role of None.
By extension, this type is also suited to typing optional fields in native JS types, i.e., fields that may not exist on the object.
final class UndefOrOps[A] extends AnyVal
sealed trait UnicodeNormalizationForm extends Any

A Unicode Normalization Form.
final class WrappedArray[A] extends AbstractBuffer[A] with GenericTraversableTemplate[A, WrappedArray] with collection.mutable.IndexedSeq[A] with BufferLike[A, WrappedArray[A]] with ArrayLike[A, WrappedArray[A]] with Builder[A, WrappedArray[A]]

Equivalent of scm.WrappedArray for js.Array.
class WrappedDictionary[A] extends AbstractMap[String, A] with Map[String, A] with MapLike[String, A, WrappedDictionary[A]]

Wrapper to use a js.
class native extends Annotation with StaticAnnotation

Marks the annotated class, trait or object as a native JS entity.
sealed trait |[A, B] extends AnyRef

Value of type A or B (union type).

Value Members

object Any extends LowPrioAnyImplicits

Provides implicit conversions from Scala values to JavaScript values.
object Array

Factory for js.Array objects.
object ArrayOps
object ConstructorTag
object Date extends Object

Factory for js.Date objects.
object Dictionary

Factory for js.Dictionary instances.
object Dynamic

Factory for dynamically typed JavaScript values.
object DynamicImplicits

Provides implicit conversions and operations to write in JavaScript style with js.Dynamic.
object Error extends Object

Annotations
@native() @JSGlobal()
object EvalError extends Object

Annotations
@native() @JSGlobal()
object Function extends Object

Annotations
@native() @JSGlobal()
object Iterator
object JSArrayOps
object JSConverters extends JSConvertersLowPrioImplicits

A collection of decorators that allow converting Scala types to corresponding JS facade types
object JSNumberOps
object JSON extends Object

The JSON object contains methods for converting values to JavaScript Object Notation (JSON) and for converting JSON to values.
object JSStringOps
object Math extends Object

Math is a built-in object that has properties and methods for mathematical constants and functions.
object Object extends Object

The top-level Object JavaScript object.
object Promise extends Object

Annotations
@native() @JSGlobal()
object RangeError extends Object

Annotations
@native() @JSGlobal()
object ReferenceError extends Object

Annotations
@native() @JSGlobal()
object RegExp extends Object

Annotations
@native() @JSGlobal()
object Symbol extends Object

ECMAScript 6 Factory for js.Symbols and well-known symbols.
object SyntaxError extends Object

Annotations
@native() @JSGlobal()
object Thenable
object ThisFunction
object Tuple2
object Tuple3
object TypeError extends Object

Annotations
@native() @JSGlobal()
object URIError extends Object

Annotations
@native() @JSGlobal()
object URIUtils extends Object

Methods related to URIs, provided by ECMAScript 5.
object UndefOrOps
object UnicodeNormalizationForm
object WrappedArray extends SeqFactory[WrappedArray]

Factory for js.WrappedArray.
object WrappedDictionary
package annotation
def constructorOf[T <: Any]: Dynamic

Returns the constructor function of a JavaScript class.
Returns the constructor function of a JavaScript class.
The specified type parameter T must be a class type (i.e., valid for classOf[T]) and represent a class extending js.Any (not a trait nor an object).
def constructorTag[T <: Any](implicit tag: ConstructorTag[T]): ConstructorTag[T]

Makes explicit an implicitly available js.ConstructorTag.
object defined
def eval(x: String): scala.Any

Evaluates JavaScript code and returns the result.
Evaluates JavaScript code and returns the result.

Annotations
@inline()
def isUndefined(v: scala.Any): Boolean

Tests whether the given value is undefined.
Tests whether the given value is undefined.

Annotations
@inline()
def native: Nothing

Denotes a method body as native JavaScript.
Denotes a method body as native JavaScript. For use in facade types:
```
class MyJSClass extends js.Object {
def myMethod(x: String): Int = js.native
}
```
package timers

Non-Standard Non-standard, but in general well supported methods to schedule asynchronous execution.
def typeOf(x: scala.Any): String

Returns the type of x as identified by typeof x in JavaScript.
package typedarray

ECMAScript 6 The typdearray package provides facade types for JavaScript ArrayBuffer, TypeArrays and DataView.
def undefined: UndefOr[Nothing]

The undefined value.
The undefined value.

Annotations
@inline()
object |

js

package js

Guide

Overview

Type Members

trait Any extends AnyRef

class Array[A] extends Object with Iterable[A]

final class ArrayOps[A] extends ArrayLike[A, Array[A]] with Builder[A, Array[A]]

final class ConstructorTag[T <: Any] extends AnyVal

class Date extends Object

sealed trait Dictionary[A] extends Any

sealed trait Dynamic extends Any with scala.Dynamic

class Error extends Object

class EvalError extends Error

class Function extends Object

trait Function0[+R] extends Function

trait Function1[-T1, +R] extends Function

trait Function2[-T1, -T2, +R] extends Function

trait Iterable[+A] extends Object

final class IterableOps[+A] extends collection.Iterable[A]

trait Iterator[+A] extends Object

trait JSArrayOps[A] extends Object

sealed abstract class JSConvertersLowPrioImplicits extends AnyRef

trait JSNumberOps extends Any

trait JSStringOps extends Any

final case class JavaScriptException(exception: scala.Any) extends RuntimeException with Product with Serializable

sealed trait LowPrioAnyImplicits extends LowestPrioAnyImplicits

sealed trait LowestPrioAnyImplicits extends AnyRef

class Object extends Any

class Promise[+A] extends Object with Thenable[A]

trait PropertyDescriptor extends Object

class RangeError extends Error

class ReferenceError extends Error

class RegExp extends Object

sealed trait Symbol extends Any

class SyntaxError extends Error

trait Thenable[+A] extends Object

trait ThisFunction extends Function

trait ThisFunction0[-T0, +R] extends Function with ThisFunction

trait ThisFunction1[-T0, -T1, +R] extends Function with ThisFunction

trait ThisFunction2[-T0, -T1, -T2, +R] extends Function with ThisFunction

sealed trait Tuple2[+T1, +T2] extends Object

sealed trait Tuple3[+T1, +T2, +T3] extends Object

class TypeError extends Error

class URIError extends Error

type UndefOr[+A] = |[A, Unit]

final class UndefOrOps[A] extends AnyVal

sealed trait UnicodeNormalizationForm extends Any

final class WrappedArray[A] extends AbstractBuffer[A] with GenericTraversableTemplate[A, WrappedArray] with collection.mutable.IndexedSeq[A] with BufferLike[A, WrappedArray[A]] with ArrayLike[A, WrappedArray[A]] with Builder[A, WrappedArray[A]]

class WrappedDictionary[A] extends AbstractMap[String, A] with Map[String, A] with MapLike[String, A, WrappedDictionary[A]]

class native extends Annotation with StaticAnnotation

sealed trait |[A, B] extends AnyRef

Value Members

object Any extends LowPrioAnyImplicits

object Array

object ArrayOps

object ConstructorTag

object Date extends Object

object Dictionary

object Dynamic

object DynamicImplicits

object Error extends Object

object EvalError extends Object

object Function extends Object

object Iterator

object JSArrayOps

object JSConverters extends JSConvertersLowPrioImplicits

object JSNumberOps

object JSON extends Object

object JSStringOps

object Math extends Object

object Object extends Object

object Promise extends Object

object RangeError extends Object

object ReferenceError extends Object

object RegExp extends Object

object Symbol extends Object

object SyntaxError extends Object

object Thenable

object ThisFunction