scala.scalajs

js

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 super type of all JavaScript values.

All class, trait and object definitions that inherit, directly or indirectly, from js.Any do not have actual implementations in Scala. They are only the manifestation of static types representing libraries written directly in JavaScript. It is not possible to implement yourself a subclass of js.Any: all the method definitions will be ignored when compiling to JavaScript.

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 subclasses of js.Any 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:

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

Linear Supertypes
AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. js
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Any extends AnyRef

    Supertype of all JavaScript values.

  2. class Array[A] extends Object

    Arrays are list-like objects whose prototype has methods to perform traversal and mutation operations.

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

    Equivalent of scm.

  4. class Date extends Object

    Creates a JavaScript Date instance that represents a single moment in time.

  5. sealed trait Dictionary[A] extends Any

    Dictionary "view" of a JavaScript value.

  6. sealed trait Dynamic extends Any with scala.Dynamic

    Dynamically typed JavaScript value.

  7. class Error extends Object

    Annotations
    @RawJSType()

  8. class EvalError extends Error

    An instance representing an error that occurs regarding the global function eval()

  9. class Function extends Object

    The Function constructor creates a new Function object.

  10. trait Function0[+R] extends Function

    Annotations
    @RawJSType()

  11. trait Function1[-T1, +R] extends Function

    Annotations
    @RawJSType()

  12. trait Function10[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, +R] extends Function

    Annotations
    @RawJSType()

  13. trait Function11[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, +R] extends Function

    Annotations
    @RawJSType()

  14. trait Function12[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, +R] extends Function

    Annotations
    @RawJSType()

  15. trait Function13[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, +R] extends Function

    Annotations
    @RawJSType()

  16. trait Function14[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, +R] extends Function

    Annotations
    @RawJSType()

  17. trait Function15[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, +R] extends Function

    Annotations
    @RawJSType()

  18. trait Function16[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, +R] extends Function

    Annotations
    @RawJSType()

  19. trait Function17[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, +R] extends Function

    Annotations
    @RawJSType()

  20. trait Function18[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, +R] extends Function

    Annotations
    @RawJSType()

  21. trait Function19[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, +R] extends Function

    Annotations
    @RawJSType()

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

    Annotations
    @RawJSType()

  23. trait Function20[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, +R] extends Function

    Annotations
    @RawJSType()

  24. trait Function21[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, -T21, +R] extends Function

    Annotations
    @RawJSType()

  25. trait Function22[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, -T21, -T22, +R] extends Function

    Annotations
    @RawJSType()

  26. trait Function3[-T1, -T2, -T3, +R] extends Function

    Annotations
    @RawJSType()

  27. trait Function4[-T1, -T2, -T3, -T4, +R] extends Function

    Annotations
    @RawJSType()

  28. trait Function5[-T1, -T2, -T3, -T4, -T5, +R] extends Function

    Annotations
    @RawJSType()

  29. trait Function6[-T1, -T2, -T3, -T4, -T5, -T6, +R] extends Function

    Annotations
    @RawJSType()

  30. trait Function7[-T1, -T2, -T3, -T4, -T5, -T6, -T7, +R] extends Function

    Annotations
    @RawJSType()

  31. trait Function8[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, +R] extends Function

    Annotations
    @RawJSType()

  32. trait Function9[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, +R] extends Function

    Annotations
    @RawJSType()

  33. trait GlobalScope extends Any

    Marker trait for top-level objects representing the JS global scope.

  34. trait JSApp extends AnyRef

    Base class for top-level, entry point main objects.

  35. trait JSArrayOps[A] extends Object

    Discouraged native JavaScript Array methods.

  36. trait JSNumberOps extends Any

    Operations on JavaScript numbers.

  37. trait JSStringOps extends Any

    Operations on JavaScript strings.

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

  39. trait LowPrioAnyImplicits extends AnyRef

  40. class Object extends Any

    Base class of all JavaScript objects.

  41. trait PropertyDescriptor extends Object

    Annotations
    @RawJSType()

  42. class RangeError extends Error

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

  43. class ReferenceError extends Error

    Represents an error when a non-existent variable is referenced.

  44. class RegExp extends Object

    The RegExp constructor creates a regular expression object for matching text with a pattern.

  45. class SyntaxError extends Error

    Represents an error when trying to interpret syntactically invalid code.

  46. trait ThisFunction extends Function

    A JavaScript function where this is considered as a first parameter.

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

    Annotations
    @RawJSType()

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

    Annotations
    @RawJSType()

  49. trait ThisFunction10[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  50. trait ThisFunction11[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  51. trait ThisFunction12[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  52. trait ThisFunction13[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  53. trait ThisFunction14[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  54. trait ThisFunction15[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  55. trait ThisFunction16[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  56. trait ThisFunction17[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  57. trait ThisFunction18[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  58. trait ThisFunction19[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

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

    Annotations
    @RawJSType()

  60. trait ThisFunction20[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  61. trait ThisFunction21[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, -T21, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  62. trait ThisFunction3[-T0, -T1, -T2, -T3, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  63. trait ThisFunction4[-T0, -T1, -T2, -T3, -T4, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  64. trait ThisFunction5[-T0, -T1, -T2, -T3, -T4, -T5, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  65. trait ThisFunction6[-T0, -T1, -T2, -T3, -T4, -T5, -T6, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  66. trait ThisFunction7[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  67. trait ThisFunction8[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  68. trait ThisFunction9[-T0, -T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, +R] extends Function with ThisFunction

    Annotations
    @RawJSType()

  69. class TypeError extends Error

    Represents an error when a value is not of the expected type.

  70. class URIError extends Error

    Represents an error when a malformed URI is encountered.

  71. sealed trait UndefOr[+A] extends AnyRef

    Value of type A or the JS undefined value.

  72. final class UndefOrOps[A] extends AnyVal

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

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

    Wrapper to use a js.

Value Members

  1. object Any extends LowPrioAnyImplicits

    Provides implicit conversions from Scala values to JavaScript values.

  2. object Array extends Object

    Factory for js.Array objects.

  3. object ArrayOps

  4. object Date extends Object

    Factory for js.Date objects.

  5. object Dictionary

    Factory for Dictionary instances.

  6. object Dynamic

    Factory for dynamically typed JavaScript values.

  7. object DynamicImplicits

    Provides implicit conversions and operations to write in JavaScript style with js.Dynamic.

  8. object Error extends Object

  9. object EvalError extends Object

  10. object Function extends Object

  11. object JSArrayOps

  12. object JSConverters

    A collection of decorators that allow converting Scala types to corresponding JS facade types

  13. object JSNumberOps

  14. object JSON extends Object

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

  15. object JSStringOps

  16. object Math extends Object

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

  17. object Object extends Object

    The top-level Object JavaScript object.

  18. object RangeError extends Object

  19. object ReferenceError extends Object

  20. object RegExp extends Object

  21. object SyntaxError extends Object

  22. object ThisFunction

  23. object TypeError extends Object

  24. object URIError extends Object

  25. object URIUtils extends GlobalScope

    Methods related to URIs, provided by ECMAScript 5.

  26. object UndefOr

  27. object UndefOrOps

  28. object WrappedArray extends SeqFactory[WrappedArray]

    $factoryInfo

  29. object WrappedDictionary

  30. package annotation

  31. def debugger(): Unit

    Invokes any available debugging functionality.

    Invokes any available debugging functionality. If no debugging functionality is available, this statement has no effect.

    MDN

    Browser support:

    • Has no effect in Rhino nor, apparently, in Firefox
    • In Chrome, it has no effect unless the developer tools are opened beforehand.

  32. def eval(x: String): Any

    Evaluates JavaScript code and returns the result.

    Evaluates JavaScript code and returns the result.

    Annotations
    @inline()

  33. def isUndefined(v: scala.Any): Boolean

    Tests whether the given value is undefined.

    Tests whether the given value is undefined.

    Annotations
    @inline()

  34. 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
}

  35. package timers

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

  36. def typeOf(x: Any): String

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

  37. package typedarray

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

  38. def undefined: UndefOr[Nothing]

    The undefined value.

    The undefined value.

    Annotations
    @inline()

Inherited from AnyRef

Inherited from scala.Any

Ungrouped