Promise

ECMAScript 6 Promise of an asynchronous result.

Attention! The nature of this class, from the ECMAScript specification, makes it inherently un-typeable, because it is not type parametric.

The signatures of the constructor and the methods then and catch are only valid provided that the values of A and B are not Thenables.

We recommend to use Scala's Futures instead of Promise as much as possible. A Promise can be converted to a Future with .toFuture and back with .toJSPromise (provided by JSConverters).

With

import scala.scalajs.js.Thenable.Implicits._

you can implicitly convert a Promise to a Future, and therefore you can directly use the methods of Future on Promises.

Annotations: @RawJSType() @native() @JSGlobal()

Linear Supertypes

Thenable[A], Object, Any, AnyRef, scala.Any

Instance Constructors

new Promise(executor: Function2[Function1[|[A, Thenable[A]], _], Function1[scala.Any, _], _])

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: scala.Any): Boolean

Definition Classes
Any
final def ##(): Int

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

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

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

Definition Classes
AnyRef
final def ==(arg0: scala.Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def catch[B >: A](onRejected: UndefOr[Function1[scala.Any, |[B, Thenable[B]]]] = js.undefined): Promise[B]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (Promise[A]) ⇒ Boolean, msg: ⇒ scala.Any): Promise[A]

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

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

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

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Tests whether this object has the specified property as a direct property.
Tests whether this object has the specified property as a direct property.
Unlike js.Object.hasProperty, this method does not check down the object's prototype chain.
MDN

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Tests whether this object is in the prototype chain of another object.
Tests whether this object is in the prototype chain of another object.

Definition Classes
Object
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val p: Thenable[A]

Implicit information
This member is added by an implicit conversion from Promise[A] to ThenableOps[A] performed by method ThenableOps in scala.scalajs.js.Thenable.
Definition Classes
ThenableOps
def propertyIsEnumerable(v: String): Boolean

Tests whether the specified property in an object can be enumerated by a call to js.Object.properties, with the exception of properties inherited through the prototype chain.
Tests whether the specified property in an object can be enumerated by a call to js.Object.properties, with the exception of properties inherited through the prototype chain. If the object does not have the specified property, this method returns false.
MDN

Definition Classes
Object
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def then[B >: A](onFulfilled: Unit, onRejected: UndefOr[Function1[scala.Any, |[B, Thenable[B]]]]): Thenable[B]

Definition Classes
Promise → Thenable
def then[B](onFulfilled: Function1[A, |[B, Thenable[B]]], onRejected: UndefOr[Function1[scala.Any, |[B, Thenable[B]]]] = js.undefined): Thenable[B]

Definition Classes
Promise → Thenable
def toFuture: Future[A]

Converts the Thenable into a Scala Future.
Converts the Thenable into a Scala Future.
Unlike when calling the then methods of Thenable, the resulting Future is always properly typed, and operations on it will be well-typed in turn.

Implicit information
This member is added by an implicit conversion from Promise[A] to ThenableOps[A] performed by method ThenableOps in scala.scalajs.js.Thenable.
Definition Classes
ThenableOps
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def valueOf(): scala.Any

Definition Classes
Object
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( ... )
def →[B](y: B): (Promise[A], B)

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

Shadowed Implicit Value Members

val self: scala.Any
Implicit information
This member is added by an implicit conversion from Promise[A] to StringAdd performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(promise: StringAdd).self
Definition Classes
StringAdd
val self: scala.Any
Implicit information
This member is added by an implicit conversion from Promise[A] to StringFormat performed by method any2stringfmt in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(promise: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: Promise[A]
Implicit information
This member is added by an implicit conversion from Promise[A] to ArrowAssoc[Promise[A]] performed by method any2ArrowAssoc in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(promise: ArrowAssoc[Promise[A]]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: Promise[A]
Implicit information
This member is added by an implicit conversion from Promise[A] to Ensuring[Promise[A]] performed by method any2Ensuring in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(promise: Ensuring[Promise[A]]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

class Promise[+A] extends Object with Thenable[A]

Instance Constructors

new Promise(executor: Function2[Function1[|[A, Thenable[A]], _], Function1[scala.Any, _], _])

Value Members

final def !=(arg0: AnyRef): Boolean

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

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Promise[A], B)

final def ==(arg0: AnyRef): Boolean

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

final def asInstanceOf[T0]: T0

def catch[B >: A](onRejected: UndefOr[Function1[scala.Any, |[B, Thenable[B]]]] = js.undefined): Promise[B]

def clone(): AnyRef

def ensuring(cond: (Promise[A]) ⇒ Boolean, msg: ⇒ scala.Any): Promise[A]

def ensuring(cond: (Promise[A]) ⇒ Boolean): Promise[A]

def ensuring(cond: Boolean, msg: ⇒ scala.Any): Promise[A]

def ensuring(cond: Boolean): Promise[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: scala.Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val p: Thenable[A]

def propertyIsEnumerable(v: String): Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def then[B >: A](onFulfilled: Unit, onRejected: UndefOr[Function1[scala.Any, |[B, Thenable[B]]]]): Thenable[B]

def then[B](onFulfilled: Function1[A, |[B, Thenable[B]]], onRejected: UndefOr[Function1[scala.Any, |[B, Thenable[B]]]] = js.undefined): Thenable[B]

def toFuture: Future[A]

def toLocaleString(): String

def toString(): String

def valueOf(): scala.Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Promise[A], B)

Shadowed Implicit Value Members

val self: scala.Any

val self: scala.Any

Deprecated Value Members

def x: Promise[A]

def x: Promise[A]

Inherited from Thenable[A]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from scala.Any

Inherited by implicit conversion ThenableOps from Promise[A] to ThenableOps[A]

Inherited by implicit conversion any2stringadd from Promise[A] to StringAdd

Inherited by implicit conversion any2stringfmt from Promise[A] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Promise[A] to ArrowAssoc[Promise[A]]

Inherited by implicit conversion any2Ensuring from Promise[A] to Ensuring[Promise[A]]

Ungrouped