Class orion.Deferred
Provides abstraction over asynchronous operations.
Defined in: </shared/eclipse/e4/orion/I201302221257/plugins/org.eclipse.orion.client.core/web/orion/Deferred.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Deferred provides abstraction over asynchronous operations.
|
Field Attributes | Field Name and Description |
---|---|
The promise exposed by this Deferred.
|
Method Attributes | Method Name and Description |
---|---|
<static> |
orion.Deferred.all(promises, optOnError)
Takes multiple promises and returns a new promise that represents the outcome of all the promises.
|
cancel(reason, strict)
Cancels this Deferred.
|
|
progress(update, strict)
Notifies listeners of progress on this Deferred.
|
|
reject(error, strict)
Rejects this Deferred.
|
|
resolve(value, strict)
Resolves this Deferred.
|
|
then(onResolve, onReject, onProgress)
Adds handlers to be called on fulfillment or progress of this promise.
|
|
<static> |
orion.Deferred.when(value, onResolve, onReject, onProgress)
Applies callbacks to a promise or to a regular object.
|
Class Detail
orion.Deferred()
Deferred provides abstraction over asynchronous operations.
Because Deferred implements the orion.Promise interface, a Deferred may be used anywhere a Promise is called for. However, in most such cases it is recommended to use the Deferred's #promise field instead, which exposes a read-only interface to callers.
Field Detail
{orion.Promise}
promise
The promise exposed by this Deferred.
Method Detail
<static>
{orion.Promise}
orion.Deferred.all(promises, optOnError)
Takes multiple promises and returns a new promise that represents the outcome of all the promises.
When all
is called with a single parameter, the returned promise has eager semantics,
meaning if one of the input promises is rejected, the returned promise also rejects, without waiting for the
rest of the promises to fulfill.
optOnError
.
- Parameters:
- {orion.Promise[]} promises
- The promises.
- {Function} optOnError Optional
- Handles a rejected input promise. When invoked,
optOnError
is passed the reason the input promise was rejected. The return value of thisoptOnError
call serves as the value of the rejected promise.
- Returns:
- {orion.Promise} A new promise. The returned promise is generally fulfilled to an
Array
whose elements give the fulfillment values of the input promises. However if an input promise is rejected and eager semantics is used, the returned promise will instead be fulfilled to a single error value.
cancel(reason, strict)
Cancels this Deferred.
{orion.Promise}
progress(update, strict)
Notifies listeners of progress on this Deferred.
- Returns:
- {orion.Promise}
{orion.Promise}
reject(error, strict)
Rejects this Deferred.
- Returns:
- {orion.Promise}
{orion.Promise}
resolve(value, strict)
Resolves this Deferred.
- Returns:
- {orion.Promise}
{orion.Promise}
then(onResolve, onReject, onProgress)
Adds handlers to be called on fulfillment or progress of this promise.
- Parameters:
- {Function} onResolve Optional
- Called when this promise is resolved.
- {Function} onReject Optional
- Called when this promise is rejected.
- {Function} onProgress Optional
- May be called to report progress events on this promise.
- Returns:
- {orion.Promise} A new promise that is fulfilled when the given onResolve or onReject callback is finished. The callback's return value gives the fulfillment value of the returned promise.
<static>
{orion.Promise}
orion.Deferred.when(value, onResolve, onReject, onProgress)
Applies callbacks to a promise or to a regular object.
- Parameters:
- {Object|orion.Promise} value
- Either a orion.Promise, or a normal value.
- {Function} onResolve
- Called when the
value
promise is resolved. Ifvalue
is not a promise, this function is called immediately. - {Function} onReject
- Called when the
value
promise is rejected. Ifvalue
is not a promise, this function is never called. - {Function} onProgress
- Called when the
value
promise provides a progress update. Ifvalue
is not a promise, this function is never called.
- Returns:
- {orion.Promise} A new promise.