sealed trait |[A, B] extends AnyRef
Value of type A or B (union type).
Scala does not have union types, but they are important to many interoperability scenarios. This type provides a (partial) encoding of union types using implicit evidences.
- Annotations
- @JSType()
- Alphabetic
- By Inheritance
- |
- AnyRef
- Any
- by undefOr2ops
- by undefOr2jsAny
- by UnionOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (|[A, B], B)
-
final
def
==(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
collect[B](pf: PartialFunction[A, B]): UndefOr[B]
Returns the result of applying
pf
to this js.UndefOr's contained value, if this option is nonempty andpf
is defined for that value.Returns the result of applying
pf
to this js.UndefOr's contained value, if this option is nonempty andpf
is defined for that value. Returns js.undefined otherwise.- pf
the partial function.
- returns
the result of applying
pf
to this js.UndefOr's value (if possible), or js.undefined.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
final
def
contains[A1 >: A](elem: A1): Boolean
Tests whether the js.UndefOr contains a given value as an element.
Tests whether the js.UndefOr contains a given value as an element.
x.contains(y)
differs fromx == y
only in the fact that it will returnfalse
whenx
andy
are bothundefined
.- elem
the element to test.
- returns
true
if the js.UndefOr has an element that is equal (as determined by==
) toelem
,false
otherwise.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- def ensuring(cond: (|[A, B]) ⇒ Boolean, msg: ⇒ scala.Any): |[A, B]
- def ensuring(cond: (|[A, B]) ⇒ Boolean): |[A, B]
- def ensuring(cond: Boolean, msg: ⇒ scala.Any): |[A, B]
- def ensuring(cond: Boolean): |[A, B]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: scala.Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
exists(p: (A) ⇒ Boolean): Boolean
Returns true if this option is nonempty and the predicate
p
returns true when applied to this js.UndefOr's value.Returns true if this option is nonempty and the predicate
p
returns true when applied to this js.UndefOr's value. Otherwise, returns false.- p
the predicate to test
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
final
def
filter(p: (A) ⇒ Boolean): UndefOr[A]
Returns this js.UndefOr if it is nonempty and applying the predicate
p
to this js.UndefOr's value returns true.Returns this js.UndefOr if it is nonempty and applying the predicate
p
to this js.UndefOr's value returns true. Otherwise, return js.undefined.- p
the predicate used for testing.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
final
def
filterNot(p: (A) ⇒ Boolean): UndefOr[A]
Returns this js.UndefOr if it is nonempty and applying the predicate
p
to this js.UndefOr's value returns false.Returns this js.UndefOr if it is nonempty and applying the predicate
p
to this js.UndefOr's value returns false. Otherwise, return js.undefined.- p
the predicate used for testing.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
flatMap[B](f: (A) ⇒ UndefOr[B]): UndefOr[B]
Returns the result of applying
f
to this js.UndefOr's value if this js.UndefOr is nonempty.Returns the result of applying
f
to this js.UndefOr's value if this js.UndefOr is nonempty. Returns js.undefined if this js.UndefOr is empty. Slightly different frommap
in thatf
is expected to return an js.UndefOr (which could be js.undefined).- f
the function to apply
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- See also
map
foreach
-
def
flatten[B](implicit ev: <:<[A, UndefOr[B]]): UndefOr[B]
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
-
final
def
fold[B](ifEmpty: ⇒ B)(f: (A) ⇒ B): B
Returns the result of applying
f
to this js.UndefOr's value if the js.UndefOr is nonempty.Returns the result of applying
f
to this js.UndefOr's value if the js.UndefOr is nonempty. Otherwise, evaluates expressionifEmpty
.- ifEmpty
the expression to evaluate if empty.
- f
the function to apply if nonempty.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- Note
This is equivalent to
js.UndefOr map f getOrElse ifEmpty
.
-
final
def
forall(p: (A) ⇒ Boolean): Boolean
Returns true if this option is empty or the predicate
p
returns true when applied to this js.UndefOr's value.Returns true if this option is empty or the predicate
p
returns true when applied to this js.UndefOr's value.- p
the predicate to test
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
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
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- See also
map
flatMap
- def formatted(fmtstr: String): String
-
final
def
get: A
Returns the option's value.
Returns the option's value.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- Exceptions thrown
java.util.NoSuchElementException
if the option is empty.- Note
The option must be nonEmpty.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
final
def
isEmpty: Boolean
Returns true if the option is
undefined
, false otherwise.Returns true if the option is
undefined
, false otherwise.- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
iterator: collection.Iterator[A]
Returns a singleton iterator returning the js.UndefOr's value if it is nonempty, or an empty iterator if the option is empty.
Returns a singleton iterator returning the js.UndefOr's value if it is nonempty, or an empty iterator if the option is empty.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
-
final
def
map[B](f: (A) ⇒ B): UndefOr[B]
Returns the result of applying
f
to this js.UndefOr's value if this js.UndefOr is nonempty.Returns the result of applying
f
to this js.UndefOr's value if this js.UndefOr is nonempty. Otherwise return js.undefined.- f
the function to apply
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- Note
This is similar to
flatMap
except here,f
does not need to wrap its result in an js.UndefOr.- See also
flatMap
foreach
-
def
merge[B](implicit ev: Evidence[|[A, B], 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
.- Implicit
- This member is added by an implicit conversion from |[A, B] to UnionOps[|[A, B]] performed by method UnionOps in scala.scalajs.js.|.
- Definition Classes
- UnionOps
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
nonEmpty: Boolean
Returns false if the option is js.undefined, true otherwise.
Returns false if the option is js.undefined, true otherwise.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Note
Implemented here to avoid the implicit conversion to Iterable.
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
orElse[B >: A](alternative: ⇒ UndefOr[B]): UndefOr[B]
Returns this js.UndefOr if it is nonempty, otherwise return the result of evaluating
alternative
.Returns this js.UndefOr if it is nonempty, otherwise return the result of evaluating
alternative
.- alternative
the alternative expression.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
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 js.UndefOr must often interface with code that expects and returns nulls.- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
val initalText: Option[String] = getInitialText val textField = new JComponent(initalText.orNull,20)
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toLeft[X](right: ⇒ X): Either[A, X]
Returns a
Right
containing the given argumentright
if this is empty, or aLeft
containing this js.UndefOr's value if this js.UndefOr is nonempty.Returns a
Right
containing the given argumentright
if this is empty, or aLeft
containing this js.UndefOr's value if this js.UndefOr is nonempty.- right
the expression to evaluate and return if this is empty
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- See also
toRight
-
def
toList: List[A]
Returns a singleton list containing the js.UndefOr's value if it is nonempty, or the empty list if the js.UndefOr is empty.
Returns a singleton list containing the js.UndefOr's value if it is nonempty, or the empty list if the js.UndefOr is empty.
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
-
final
def
toOption: Option[A]
Returns a
Some
containing this js.UndefOr's value if this js.UndefOr is nonempty, None otherwise.Returns a
Some
containing this js.UndefOr's value if this js.UndefOr is nonempty, None otherwise.- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
-
final
def
toRight[X](left: ⇒ X): Either[X, A]
Returns a
Left
containing the given argumentleft
if this js.UndefOr is empty, or aRight
containing this js.UndefOr's value if this is nonempty.Returns a
Left
containing the given argumentleft
if this js.UndefOr is empty, or aRight
containing this js.UndefOr's value if this is nonempty.- left
the expression to evaluate and return if this is empty
- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- See also
toLeft
-
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()
-
final
def
withFilter(p: (A) ⇒ Boolean): WithFilter[A]
Necessary to keep js.UndefOr from being implicitly converted to scala.collection.Iterable in
for
comprehensions.Necessary to keep js.UndefOr from being implicitly converted to scala.collection.Iterable in
for
comprehensions.- Implicit
- This member is added by an implicit conversion from |[A, B] to UndefOrOps[A] performed by method undefOr2ops in scala.scalajs.js.|. This conversion will take place only if B is Unit (B =:= Unit).
- Definition Classes
- UndefOrOps
- Annotations
- @inline()
- def →[B](y: B): (|[A, B], B)