Packages

package root

Definition Classes: root

package scala

Definition Classes: root

package scalajs

Definition Classes: scala

package 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.

Definition Classes: scalajs

package annotation

Definition Classes: js

Any

Array

ArrayOps

BigInt

ConstructorTag

Date

Dictionary

Dynamic

DynamicImplicits

Error

EvalError

Function

Function0

Function1

Function2

Iterable

IterableOps

Iterator

JSConverters

JSConvertersLowPrioImplicits

JSNumberOps

JSON

JSStringOps

JavaScriptException

LowPrioAnyImplicits

LowestPrioAnyImplicits

Math

Object

Promise

PropertyDescriptor

RangeError

ReferenceError

RegExp

Symbol

SyntaxError

Thenable

ThisFunction

ThisFunction0

ThisFunction1

ThisFunction2

Tuple2

Tuple3

TypeError

URIError

URIUtils

UndefOrOps

UnicodeNormalizationForm

WrappedArray

WrappedDictionary

defined

import

native

package timers

Non-Standard Non-standard, but in general well supported methods to schedule asynchronous execution.

The methods in this package work in all JavaScript virtual machines supporting setTimeout and setInterval.

Definition Classes: js

package typedarray

ECMAScript 6 The typdearray package provides facade types for JavaScript ArrayBuffer, TypeArrays and DataView.

ECMAScript 6 The typdearray package provides facade types for JavaScript ArrayBuffer, TypeArrays and DataView. Further, it provides conversions between primitive Scala arrays and TypedArrays

Definition Classes: js

scala.scalajs.js

defined

object defined

Linear Supertypes

AnyRef, scala.Any

Ordering

Alphabetic
By Inheritance

Inherited

defined
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: scala.Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: scala.Any): Boolean

Definition Classes
AnyRef → Any

def apply[A](a: A): UndefOr[A]

Explicitly upcasts an A to a js.UndefOr[A].

This method is useful in some cases to drive Scala's type inference. For example, when calling a method expecting a js.UndefOr[js.FunctionN] as shown below:

def foo(f: js.UndefOr[js.Function1[Int, Int]] = js.undefined): Int = ???

foo((x: Int) => x + 1) // compile error (requires 2 chained implicits)
foo(js.defined((x: Int) => x + 1)) // compiles

// 2.12+ only:
foo(js.defined(x => x + 1)) // compiles as well

final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: scala.Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

Guide

Overview

defined

object defined

Value Members

Inherited from AnyRef

Inherited from scala.Any

Ungrouped

Packages

Guide

Overview

defined 

object defined

Value Members

Inherited from AnyRef

Inherited from scala.Any

Ungrouped

defined