| method | \ndescription | \nreturns | \n
|---|---|---|
| var promise = await(item1, item2, ... itemN) | \n Returns a promise, pending the fulfillment of the given set of things. The new keyword is not needed. Accepts one or more args which can be strings or other promises, which allows grouping. Order of arguments is unimportant. | \n promise | \n
| promise.run(callback[, context]) | \nRuns callback immediately (synchronously), which contains whatever promise fulfillment logic you want. callback is passed a reference to the promise. If defined and not null, context will be this in callback. Exceptions thrown by callback automatically fail the promise. | \n itself | \n
| promise.onkeep(callback[, context]) | \nCalls callback when every item of the promise is fulfilled. If the promise is already fulfilled, callback runs immediately. callback is passed a map of all the things in the promise, keyed by the strings passed to await(). If defined and not null, context will be this in callback. | \n itself | \n
| promise.onfail(callback[, context]) | \nCalls callback when promise fails. If promise already failed, callback runs immediately. callback is passed the error object representing the reason for the failure, which was passed to fail() method triggering the failure. If defined and not null, context will be this in callback. | \n itself | \n
| promise.onresolve(callback[, context]) | \nCalls callback when promise either keeps or fails. If promise has already been kept or failed, callback runs immediately. If defined and not null, context will be this in callback. | \n itself | \n
| promise.onprogress(callback[, context]) | \nCalls callback whenever there is progress to report. callback is only called while promise is unresolved. callback may be called any number of times, or never called at all. If promise has already been kept or failed, callback is ignored and discarded. callback is passed an object keyed by names and valued by numbers between 0.0 and 1.0. If defined and not null, context will be this in callback. | \n itself | \n
| promise.then(onkeep, onfail, onprogress) | \nConforms to the signature and behavioral conventions outlined in the Promises/A+ spec. | \nA new await.js promise | \n
| promise.catch(onfail) | \nConvenience method that behaves equivalent to promise.then(null, onfail). | \n A new await.js promise | \n
| promise.keep(item[, data]) | \nFulfills one of the things of this promise. data is optional and if not defined, defaults to null. | \n itself | \n
| promise.fail(reason) | \nFail the promise for the given reason. The first argument should be an error object. | \n itself | \n
| promise.progress(name, amount) | \nNotify any progress listeners of progress on item name. amount is a fractional value between 0.0 and 1.0. Lower values will be converted to 0.0, higher ones converted to 1.0. | \n itself | \n
| promise.take(otherPromise[, map]) | \nSet up a dependency chain so that promise depends on otherPromise. map is optional and provides custom mapping from otherPromise to promise. The dependency is such that if otherPromise fails, promise fails. | \n itself | \n
| promise.things() | \nRetrieve a list of things this promise is awaiting. | \narray | \n
| promise.map(mapping) | \nGet a copy of this promise. mapping updates the names of the things in the new promise, which is useful for avoiding naming conflicts during grouping. The copy is automatically chained to the original. | \n different promise | \n
| promise.nodify(item1, item2, ... itemN) | \nThis method is intended for use with node.js's error-first callback signature. It returns a function that can be used as a callback in a node.js async call. If an error is passed to the callback, it fails the promise. Otherwise, success params are matched to each named item, in the order provided. | \nfunction | \n
| promise.nodify(callback[, context]) | \nThis method is intended for use with node.js's error-first callback signature. It returns a function that can be used as a callback in a node.js async call. If an error is passed to the callback, it fails the promise. Otherwise, the callback is executed with the given context, if provided. | \nfunction | \n