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.

    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:

    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
  • package internal
  • ExposedJSMember
  • JSBracketAccess
  • JSBracketCall
  • JSExport
  • JSExportAll
  • JSExportDescendentClasses
  • JSExportDescendentObjects
  • JSExportNamed
  • JSExportTopLevel
  • JSFullName
  • JSGlobalScope
  • JSImport
  • JSName
  • JavaDefaultMethod
  • RawJSType
  • SJSDefinedAnonymousClass
  • ScalaJSDefined
  • WasPublicBeforeTyper
  • package timers

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

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

    The methods in this package work in all JavaScript virtual machines supported by Scala.js (currently Rhino, Node.js and PhantomJS).

    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
p

scala.scalajs.js

annotation

package annotation

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. class ExposedJSMember extends Annotation with StaticAnnotation

    IMPLEMENTATION DETAIL: Marks the annotated member as exposed as a JS member.

    IMPLEMENTATION DETAIL: Marks the annotated member as exposed as a JS member.

    This annotation is added automatically by the compiler to all public and protected members of a Scala.js-defined JS class. It marks the annotated member as being exposed as a JS member.

    Do not use this annotation yourself.

  2. class JSBracketAccess extends Annotation with StaticAnnotation

    Marks the annotated method as representing bracket access in JavaScript.

    Marks the annotated method as representing bracket access in JavaScript.

    See also

    Calling JavaScript from Scala.js

  3. class JSBracketCall extends Annotation with StaticAnnotation

    Marks the annotated method as representing bracket call in JavaScript.

    Marks the annotated method as representing bracket call in JavaScript.

    See also

    Calling JavaScript from Scala.js

  4. class JSExport extends Annotation with StaticAnnotation

    Specifies that the given entity should be exported for use in raw JS.

    Specifies that the given entity should be exported for use in raw JS.

    Annotations
    @field() @getter() @setter()
    See also

    Export Scala.js APIs to JavaScript

  5. class JSExportAll extends Annotation with StaticAnnotation

    Exports all public members directly defined in a class / object.

    Exports all public members directly defined in a class / object.

    Strictly equivalent to putting JSExport on every public member. Note: You are allowed to export protected members, but you'll have to do this explicitly on each member.

    See also

    Export Scala.js APIs to JavaScript

  6. class JSExportDescendentClasses extends Annotation with StaticAnnotation

    Specifies that all the concrete classes extending the annotated class or should have all their public constructors exported for use in raw JS.

    Specifies that all the concrete classes extending the annotated class or should have all their public constructors exported for use in raw JS. The constructors exported this way are exported under their fully qualified name.

    See also

    Export Scala.js APIs to JavaScript

  7. class JSExportDescendentObjects extends Annotation with StaticAnnotation

    Specifies that all the objects extending the annotated class or trait should be exported for use in raw JS.

    Specifies that all the objects extending the annotated class or trait should be exported for use in raw JS. Note that objects exported this way are exported under their fully qualified name.

    See also

    Export Scala.js APIs to JavaScript

  8. class JSExportTopLevel extends Annotation with StaticAnnotation

    Specifies that the given member should be exported to the top level of the module.

    Specifies that the given member should be exported to the top level of the module.

    Annotations
    @field() @getter() @setter()
    See also

    Export Scala.js APIs to JavaScript

  9. class JSGlobalScope extends Annotation with StaticAnnotation

    Marks the annotated object as representing the JavaScript global scope.

    Marks the annotated object as representing the JavaScript global scope.

    This is particularly useful to model top-level functions and fields that are in the JavaScript global scope. They can be declared inside an object annotated with @JSGlobalScope.

    See also

    Calling JavaScript from Scala.js

  10. class JSImport extends Annotation with StaticAnnotation

    Marks the annotated class or object as imported from another JS module.

    Marks the annotated class or object as imported from another JS module.

    Intuitively, this corresponds to the following ECMAScript import directive:

    import { <name> as AnnotatedClassOrObject } from <module>

    To import the default export of a module, use JSImport.Default as name.

    @JSImport is not compatible with the jsDependencies mechanism offered by the Scala.js sbt plugin. You are responsible for resolving and/or bundling the JavaScript modules that you are importing using other mechanisms.

  11. class JSName extends Annotation with StaticAnnotation

    Specifies the JavaScript name of an entity.

    Specifies the JavaScript name of an entity.

    Annotations
    @field() @getter() @setter()
    See also

    Calling JavaScript from Scala.js

  12. class JavaDefaultMethod extends Annotation with StaticAnnotation

    Mark a concrete trait method as a Java default method.

    Mark a concrete trait method as a Java default method.

    This annotation can be used on concrete trait methods to mark them as Java default methods. This should be used *only* to implement interfaces of the JDK that have default methods in Java.

    Otherwise using this annotation is unspecified.

  13. class RawJSType extends Annotation with StaticAnnotation

    Marks the annotated class, trait or object as a raw JavaScript type.

    Marks the annotated class, trait or object as a raw JavaScript type.

    This annotation is added automatically by the compiler to all classes, traits and objects inheriting directly or indirectly from scala.scalajs.js.Any. It marks the annotated entity as being a raw JavaScript type, i.e., one that represents type information for an entity defined in JavaScript code.

    Do not use this annotation yourself.

  14. class SJSDefinedAnonymousClass extends Annotation

    IMPLEMENTATION DETAIL: Marks anonymous Scala.js-defined JS classes.

    IMPLEMENTATION DETAIL: Marks anonymous Scala.js-defined JS classes.

    This annotation is added automatically by the compiler to Scala.js defined anonymous classes.

    Do not use this annotation yourself.

  15. class ScalaJSDefined extends Annotation with StaticAnnotation

    Marks the annotated class as a Scala.js-defined JavaScript class.

    Marks the annotated class as a Scala.js-defined JavaScript class.

    This annotation may only be used on a class extending js.Any.

  16. class WasPublicBeforeTyper extends Annotation

    IMPLEMENTATION DETAIL: Marks public members of anonymous classes before typer.

    IMPLEMENTATION DETAIL: Marks public members of anonymous classes before typer.

    This annotation is added automatically by the compiler to all public members of anonymous classes.

    Do not use this annotation yourself.

  17. class JSExportNamed extends Annotation with StaticAnnotation

    Exports the given method to JavaScript with named parameters.

    Exports the given method to JavaScript with named parameters.

    It can then be called like this:

    obj.foo({
      param1: value1
      param2: value2
      param7: value3
    });

    Note that named exports don't support overloading. Therefore the following will fail:

    class A {
      @JSExportNamed
      def a(foo: Int) = foo + 1
      @JSExportNamed
      def a(bar: String) = "Hello " + bar
    }

    As of Scala.js 0.6.11, @JSExportNamed is deprecated without direct replacement (see https://github.com/scala-js/scala-js/issues/2442). You should take a single parameter of a JS type and decompose it yourself. For example, instead of

    class A {
      @JSExportNamed
      def foo(a: Int, b: String, c: Boolean = false): Unit = {
        // do something with a, b, c
      }
    }

    you should write:

    @ScalaJSDefined
    trait FooOptions extends js.Object {
      val a: Int
      val b: String
      val c: js.UndefOr[Boolean]
    }
    
    class A {
      @JSExport
      def foo(options: FooOptions): Unit = {
        val a = options.a
        val b = options.b
        val c = options.c.getOrElse(false)
        // do something with a, b, c
      }
    }
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.11)

    See also

    Export Scala.js APIs to JavaScript

  18. class JSFullName extends Annotation with StaticAnnotation

    IMPLEMENTATION DETAIL: Saves the fully qualified JS name of a symbol.

    IMPLEMENTATION DETAIL: Saves the fully qualified JS name of a symbol.

    This annotation was used prior to Scala.js 0.6.13. It is only kept for backwards binary compatibility, and should not be used anymore.

    Do not use this annotation yourself.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.13) Replaced by internal.JSNativeLoadSpec.

Value Members

  1. object JSImport

Ungrouped