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
  • object |
    Definition Classes
    js
  • Evidence
  • EvidenceLowPrioImplicits
  • EvidenceLowestPrioImplicits
  • UnionOps
c

scala.scalajs.js.|

UnionOps

implicit final class UnionOps[A <: |[_, _]] extends AnyVal

Operations on union types.

Linear Supertypes
AnyVal, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnionOps
  2. AnyVal
  3. Any
Implicitly
  1. by from
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toany2stringadd[UnionOps[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UnionOps[A], B)
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toArrowAssoc[UnionOps[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def ensuring(cond: (UnionOps[A]) => Boolean, msg: => scala.Any): UnionOps[A]
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toEnsuring[UnionOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (UnionOps[A]) => Boolean): UnionOps[A]
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toEnsuring[UnionOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => scala.Any): UnionOps[A]
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toEnsuring[UnionOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): UnionOps[A]
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toEnsuring[UnionOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def merge[B](implicit ev: Evidence[A, B]): B

    Explicitly merge a union type to a supertype (which might not be a union type itself).

    Explicitly merge a union type to a supertype (which might not be a union type itself).

    This needs evidence that A <: B.

  14. def toString(): String
    Definition Classes
    Any

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toStringFormat[UnionOps[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (UnionOps[A], B)
    Implicit
    This member is added by an implicit conversion from UnionOps[A] toArrowAssoc[UnionOps[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyVal

Inherited from scala.Any

Inherited by implicit conversion from fromUnionOps[A] to |[B1, B2]

Inherited by implicit conversion any2stringadd fromUnionOps[A] to any2stringadd[UnionOps[A]]

Inherited by implicit conversion StringFormat fromUnionOps[A] to StringFormat[UnionOps[A]]

Inherited by implicit conversion Ensuring fromUnionOps[A] to Ensuring[UnionOps[A]]

Inherited by implicit conversion ArrowAssoc fromUnionOps[A] to ArrowAssoc[UnionOps[A]]

Ungrouped