scala.scalajs.js

UndefOr

sealed trait UndefOr[+A] extends AnyRef

Value of type A or the JS undefined value. In a type system with union types, this would really be A | js.prim.Undefined. Since Scala does not have union types, but this particular union is crucial to many interoperability scenarios, it is provided as this trait.

An API similar to that of scala.Option is provided through the UndefOrOps implicit class, with the understanding that undefined is the None value.

Linear Supertypes
AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UndefOr
  2. AnyRef
  3. Any
Implicitly
  1. by undefOr2ops
  2. by any2undefOrA
  3. by undefOr2jsAny
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

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

    Definition Classes
    AnyRef → Any
  3. def +(other: Predef.String): Predef.String

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to any2stringadd[UndefOr[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UndefOr[A], B)

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to ArrowAssoc[UndefOr[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: scala.Any): scala.Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def collect[B](pf: PartialFunction[A, B]): UndefOr[B]

    Returns a $some containing the result of applying pf to this $option's contained value, if this option is nonempty and pf is defined for that value.

    Returns a $some containing the result of applying pf to this $option's contained value, if this option is nonempty and pf is defined for that value. Returns $none otherwise.

    pf

    the partial function.

    returns

    the result of applying pf to this $option's value (if possible), or $none.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  9. def ensuring(cond: (UndefOr[A]) ⇒ scala.Boolean, msg: ⇒ scala.Any): UndefOr[A]

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to Ensuring[UndefOr[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (UndefOr[A]) ⇒ scala.Boolean): UndefOr[A]

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to Ensuring[UndefOr[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: scala.Boolean, msg: ⇒ scala.Any): UndefOr[A]

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to Ensuring[UndefOr[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: scala.Boolean): UndefOr[A]

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to Ensuring[UndefOr[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): scala.Boolean

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

    Definition Classes
    AnyRef → Any
  15. final def exists(p: (A) ⇒ Boolean): Boolean

    Returns true if this option is nonempty and the predicate $p returns true when applied to this $option's value.

    Returns true if this option is nonempty and the predicate $p returns true when applied to this $option's value. Otherwise, returns false.

    p

    the predicate to test

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  16. final def filter(p: (A) ⇒ Boolean): UndefOr[A]

    Returns this $option if it is nonempty and applying the predicate $p to this $option's value returns true.

    Returns this $option if it is nonempty and applying the predicate $p to this $option's value returns true. Otherwise, return $none.

    p

    the predicate used for testing.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  17. final def filterNot(p: (A) ⇒ Boolean): UndefOr[A]

    Returns this $option if it is nonempty and applying the predicate $p to this $option's value returns false.

    Returns this $option if it is nonempty and applying the predicate $p to this $option's value returns false. Otherwise, return $none.

    p

    the predicate used for testing.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def flatMap[B](f: (A) ⇒ UndefOr[B]): UndefOr[B]

    Returns the result of applying $f to this $option's value if this $option is nonempty.

    Returns the result of applying $f to this $option's value if this $option is nonempty. Returns $none if this $option is empty. Slightly different from map in that $f is expected to return an $option (which could be $none).

    f

    the function to apply

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    See also

    foreach

    map

  20. def flatten[B](implicit ev: <:<[A, UndefOr[B]]): UndefOr[B]

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
  21. final def fold[B](ifEmpty: ⇒ B)(f: (A) ⇒ B): B

    Returns the result of applying $f to this $option's value if the $option is nonempty.

    Returns the result of applying $f to this $option's value if the $option is nonempty. Otherwise, evaluates expression ifEmpty.

    ifEmpty

    the expression to evaluate if empty.

    f

    the function to apply if nonempty.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    Note

    This is equivalent to $option map f getOrElse ifEmpty.

  22. final def forall(p: (A) ⇒ Boolean): Boolean

    Returns true if this option is empty or the predicate $p returns true when applied to this $option's value.

    Returns true if this option is empty or the predicate $p returns true when applied to this $option's value.

    p

    the predicate to test

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  23. final def foreach[U](f: (A) ⇒ U): Unit

    Apply the given procedure $f to the option's value, if it is nonempty.

    Apply the given procedure $f to the option's value, if it is nonempty. Otherwise, do nothing.

    f

    the procedure to apply.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    See also

    flatMap

    map

  24. def formatted(fmtstr: Predef.String): Predef.String

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to StringFormat[UndefOr[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def get: A

    Returns the option's value.

    Returns the option's value.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    Exceptions thrown
    Predef.NoSuchElementException

    if the option is empty.

    Note

    The option must be nonEmpty.

  26. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  27. final def getOrElse[B >: A](default: ⇒ B): B

    Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.

    Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.

    default

    the default expression.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  28. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  29. final def isDefined: Boolean

    Returns true if the option is not undefined, false otherwise.

    Returns true if the option is not undefined, false otherwise.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  30. final def isEmpty: Boolean

    Returns true if the option is undefined, false otherwise.

    Returns true if the option is undefined, false otherwise.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  31. final def isInstanceOf[T0]: scala.Boolean

    Definition Classes
    Any
  32. def iterator: Iterator[A]

    Returns a singleton iterator returning the $option's value if it is nonempty, or an empty iterator if the option is empty.

    Returns a singleton iterator returning the $option's value if it is nonempty, or an empty iterator if the option is empty.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
  33. final def map[B](f: (A) ⇒ B): UndefOr[B]

    Returns a $some containing the result of applying $f to this $option's value if this $option is nonempty.

    Returns a $some containing the result of applying $f to this $option's value if this $option is nonempty. Otherwise return $none.

    f

    the function to apply

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    Note

    This is similar to flatMap except here, $f does not need to wrap its result in an $option.

    See also

    foreach

    flatMap

  34. final def ne(arg0: AnyRef): scala.Boolean

    Definition Classes
    AnyRef
  35. final def nonEmpty: Boolean

    Returns false if the option is $none, true otherwise.

    Returns false if the option is $none, true otherwise.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Note

    Implemented here to avoid the implicit conversion to Iterable.

  36. final def notify(): Unit

    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  38. final def orElse[B >: A](alternative: ⇒ UndefOr[B]): UndefOr[B]

    Returns this $option if it is nonempty, otherwise return the result of evaluating alternative.

    Returns this $option if it is nonempty, otherwise return the result of evaluating alternative.

    alternative

    the alternative expression.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  39. final def orNull[A1 >: A](implicit ev: <:<[Null, A1]): A1

    Returns the option's value if it is nonempty, or null if it is empty.

    Returns the option's value if it is nonempty, or null if it is empty. Although the use of null is discouraged, code written to use $option must often interface with code that expects and returns nulls.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    Example:
    1. val initalText: Option[String] = getInitialText
      val textField = new JComponent(initalText.orNull,20)
  40. val self: UndefOr[A]

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  42. final def toLeft[X](right: ⇒ X): Either[A, X]

    Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this $option's value if this $option is nonempty.

    Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this $option's value if this $option is nonempty.

    right

    the expression to evaluate and return if this is empty

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    See also

    toRight

  43. def toList: List[A]

    Returns a singleton list containing the $option's value if it is nonempty, or the empty list if the $option is empty.

    Returns a singleton list containing the $option's value if it is nonempty, or the empty list if the $option is empty.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
  44. final def toRight[X](left: ⇒ X): Either[X, A]

    Returns a scala.util.Left containing the given argument left if this $option is empty, or a scala.util.Right containing this $option's value if this is nonempty.

    Returns a scala.util.Left containing the given argument left if this $option is empty, or a scala.util.Right containing this $option's value if this is nonempty.

    left

    the expression to evaluate and return if this is empty

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
    See also

    toLeft

  45. def toString(): java.lang.String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def withFilter(p: (A) ⇒ Boolean): WithFilter[A]

    Necessary to keep $option from being implicitly converted to scala.collection.Iterable in for comprehensions.

    Necessary to keep $option from being implicitly converted to scala.collection.Iterable in for comprehensions.

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.UndefOr.
    Definition Classes
    UndefOrOps
    Annotations
    @inline()
  50. def [B](y: B): (UndefOr[A], B)

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to ArrowAssoc[UndefOr[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def unary_!(): Boolean

    Implicit information
    This member is added by an implicit conversion from UndefOr[A] to Any performed by method undefOr2jsAny in scala.scalajs.js.UndefOr. This conversion will take place only if an implicit value of type (A) ⇒ Any is in scope.
    Definition Classes
    Any
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5.0)

Inherited from AnyRef

Inherited from scala.Any

Inherited by implicit conversion undefOr2ops from UndefOr[A] to UndefOrOps[A]

Inherited by implicit conversion any2undefOrA from UndefOr[A] to UndefOr[UndefOr[A]]

Inherited by implicit conversion undefOr2jsAny from UndefOr[A] to Any

Inherited by implicit conversion any2stringadd from UndefOr[A] to any2stringadd[UndefOr[A]]

Inherited by implicit conversion StringFormat from UndefOr[A] to StringFormat[UndefOr[A]]

Inherited by implicit conversion Ensuring from UndefOr[A] to Ensuring[UndefOr[A]]

Inherited by implicit conversion ArrowAssoc from UndefOr[A] to ArrowAssoc[UndefOr[A]]

Ungrouped