12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474 |
- /*!
- * @overview RSVP - a tiny implementation of Promises/A+.
- * @copyright Copyright (c) 2016 Yehuda Katz, Tom Dale, Stefan Penner and contributors
- * @license Licensed under MIT license
- * See https://raw.githubusercontent.com/tildeio/rsvp.js/master/LICENSE
- * @version 4.8.4+ff10049b
- */
- function callbacksFor(object) {
- let callbacks = object._promiseCallbacks;
- if (!callbacks) {
- callbacks = object._promiseCallbacks = {};
- }
- return callbacks;
- }
- /**
- @class EventTarget
- @for rsvp
- @public
- */
- var EventTarget = {
- /**
- `EventTarget.mixin` extends an object with EventTarget methods. For
- Example:
- ```javascript
- import EventTarget from 'rsvp';
- let object = {};
- EventTarget.mixin(object);
- object.on('finished', function(event) {
- // handle event
- });
- object.trigger('finished', { detail: value });
- ```
- `EventTarget.mixin` also works with prototypes:
- ```javascript
- import EventTarget from 'rsvp';
- let Person = function() {};
- EventTarget.mixin(Person.prototype);
- let yehuda = new Person();
- let tom = new Person();
- yehuda.on('poke', function(event) {
- console.log('Yehuda says OW');
- });
- tom.on('poke', function(event) {
- console.log('Tom says OW');
- });
- yehuda.trigger('poke');
- tom.trigger('poke');
- ```
- @method mixin
- @for rsvp
- @private
- @param {Object} object object to extend with EventTarget methods
- */
- mixin(object) {
- object.on = this.on;
- object.off = this.off;
- object.trigger = this.trigger;
- object._promiseCallbacks = undefined;
- return object;
- },
- /**
- Registers a callback to be executed when `eventName` is triggered
- ```javascript
- object.on('event', function(eventInfo){
- // handle the event
- });
- object.trigger('event');
- ```
- @method on
- @for EventTarget
- @private
- @param {String} eventName name of the event to listen for
- @param {Function} callback function to be called when the event is triggered.
- */
- on(eventName, callback) {
- if (typeof callback !== 'function') {
- throw new TypeError('Callback must be a function');
- }
- let allCallbacks = callbacksFor(this);
- let callbacks = allCallbacks[eventName];
- if (!callbacks) {
- callbacks = allCallbacks[eventName] = [];
- }
- if (callbacks.indexOf(callback) === -1) {
- callbacks.push(callback);
- }
- },
- /**
- You can use `off` to stop firing a particular callback for an event:
- ```javascript
- function doStuff() { // do stuff! }
- object.on('stuff', doStuff);
- object.trigger('stuff'); // doStuff will be called
- // Unregister ONLY the doStuff callback
- object.off('stuff', doStuff);
- object.trigger('stuff'); // doStuff will NOT be called
- ```
- If you don't pass a `callback` argument to `off`, ALL callbacks for the
- event will not be executed when the event fires. For example:
- ```javascript
- let callback1 = function(){};
- let callback2 = function(){};
- object.on('stuff', callback1);
- object.on('stuff', callback2);
- object.trigger('stuff'); // callback1 and callback2 will be executed.
- object.off('stuff');
- object.trigger('stuff'); // callback1 and callback2 will not be executed!
- ```
- @method off
- @for rsvp
- @private
- @param {String} eventName event to stop listening to
- @param {Function} [callback] optional argument. If given, only the function
- given will be removed from the event's callback queue. If no `callback`
- argument is given, all callbacks will be removed from the event's callback
- queue.
- */
- off(eventName, callback) {
- let allCallbacks = callbacksFor(this);
- if (!callback) {
- allCallbacks[eventName] = [];
- return;
- }
- let callbacks = allCallbacks[eventName];
- let index = callbacks.indexOf(callback);
- if (index !== -1) {
- callbacks.splice(index, 1);
- }
- },
- /**
- Use `trigger` to fire custom events. For example:
- ```javascript
- object.on('foo', function(){
- console.log('foo event happened!');
- });
- object.trigger('foo');
- // 'foo event happened!' logged to the console
- ```
- You can also pass a value as a second argument to `trigger` that will be
- passed as an argument to all event listeners for the event:
- ```javascript
- object.on('foo', function(value){
- console.log(value.name);
- });
- object.trigger('foo', { name: 'bar' });
- // 'bar' logged to the console
- ```
- @method trigger
- @for rsvp
- @private
- @param {String} eventName name of the event to be triggered
- @param {*} [options] optional value to be passed to any event handlers for
- the given `eventName`
- */
- trigger(eventName, options, label) {
- let allCallbacks = callbacksFor(this);
- let callbacks = allCallbacks[eventName];
- if (callbacks) {
- // Don't cache the callbacks.length since it may grow
- let callback;
- for (let i = 0; i < callbacks.length; i++) {
- callback = callbacks[i];
- callback(options, label);
- }
- }
- }
- };
- const config = {
- instrument: false
- };
- EventTarget['mixin'](config);
- function configure(name, value) {
- if (arguments.length === 2) {
- config[name] = value;
- } else {
- return config[name];
- }
- }
- const queue = [];
- function scheduleFlush() {
- setTimeout(() => {
- for (let i = 0; i < queue.length; i++) {
- let entry = queue[i];
- let payload = entry.payload;
- payload.guid = payload.key + payload.id;
- payload.childGuid = payload.key + payload.childId;
- if (payload.error) {
- payload.stack = payload.error.stack;
- }
- config['trigger'](entry.name, entry.payload);
- }
- queue.length = 0;
- }, 50);
- }
- function instrument(eventName, promise, child) {
- if (1 === queue.push({
- name: eventName,
- payload: {
- key: promise._guidKey,
- id: promise._id,
- eventName: eventName,
- detail: promise._result,
- childId: child && child._id,
- label: promise._label,
- timeStamp: Date.now(),
- error: config["instrument-with-stack"] ? new Error(promise._label) : null
- }})) {
- scheduleFlush();
- }
- }
- /**
- `Promise.resolve` returns a promise that will become resolved with the
- passed `value`. It is shorthand for the following:
- ```javascript
- import Promise from 'rsvp';
- let promise = new Promise(function(resolve, reject){
- resolve(1);
- });
- promise.then(function(value){
- // value === 1
- });
- ```
- Instead of writing the above, your code now simply becomes the following:
- ```javascript
- import Promise from 'rsvp';
- let promise = RSVP.Promise.resolve(1);
- promise.then(function(value){
- // value === 1
- });
- ```
- @method resolve
- @for Promise
- @static
- @param {*} object value that the returned promise will be resolved with
- @param {String} [label] optional string for identifying the returned promise.
- Useful for tooling.
- @return {Promise} a promise that will become fulfilled with the given
- `value`
- */
- function resolve$$1(object, label) {
- /*jshint validthis:true */
- let Constructor = this;
- if (object && typeof object === 'object' && object.constructor === Constructor) {
- return object;
- }
- let promise = new Constructor(noop, label);
- resolve$1(promise, object);
- return promise;
- }
- function withOwnPromise() {
- return new TypeError('A promises callback cannot return that same promise.');
- }
- function objectOrFunction(x) {
- let type = typeof x;
- return x !== null && (type === 'object' || type === 'function');
- }
- function noop() {}
- const PENDING = void 0;
- const FULFILLED = 1;
- const REJECTED = 2;
- const TRY_CATCH_ERROR = { error: null };
- function getThen(promise) {
- try {
- return promise.then;
- } catch(error) {
- TRY_CATCH_ERROR.error = error;
- return TRY_CATCH_ERROR;
- }
- }
- let tryCatchCallback;
- function tryCatcher() {
- try {
- let target = tryCatchCallback;
- tryCatchCallback = null;
- return target.apply(this, arguments);
- } catch(e) {
- TRY_CATCH_ERROR.error = e;
- return TRY_CATCH_ERROR;
- }
- }
- function tryCatch(fn) {
- tryCatchCallback = fn;
- return tryCatcher;
- }
- function handleForeignThenable(promise, thenable, then$$1) {
- config.async(promise => {
- let sealed = false;
- let result = tryCatch(then$$1).call(
- thenable,
- value => {
- if (sealed) { return; }
- sealed = true;
- if (thenable === value) {
- fulfill(promise, value);
- } else {
- resolve$1(promise, value);
- }
- },
- reason => {
- if (sealed) { return; }
- sealed = true;
- reject(promise, reason);
- },
- 'Settle: ' + (promise._label || ' unknown promise')
- );
- if (!sealed && result === TRY_CATCH_ERROR) {
- sealed = true;
- let error = TRY_CATCH_ERROR.error;
- TRY_CATCH_ERROR.error = null;
- reject(promise, error);
- }
- }, promise);
- }
- function handleOwnThenable(promise, thenable) {
- if (thenable._state === FULFILLED) {
- fulfill(promise, thenable._result);
- } else if (thenable._state === REJECTED) {
- thenable._onError = null;
- reject(promise, thenable._result);
- } else {
- subscribe(thenable, undefined, value => {
- if (thenable === value) {
- fulfill(promise, value);
- } else {
- resolve$1(promise, value);
- }
- }, reason => reject(promise, reason));
- }
- }
- function handleMaybeThenable(promise, maybeThenable, then$$1) {
- let isOwnThenable =
- maybeThenable.constructor === promise.constructor &&
- then$$1 === then &&
- promise.constructor.resolve === resolve$$1;
- if (isOwnThenable) {
- handleOwnThenable(promise, maybeThenable);
- } else if (then$$1 === TRY_CATCH_ERROR) {
- let error = TRY_CATCH_ERROR.error;
- TRY_CATCH_ERROR.error = null;
- reject(promise, error);
- } else if (typeof then$$1 === 'function') {
- handleForeignThenable(promise, maybeThenable, then$$1);
- } else {
- fulfill(promise, maybeThenable);
- }
- }
- function resolve$1(promise, value) {
- if (promise === value) {
- fulfill(promise, value);
- } else if (objectOrFunction(value)) {
- handleMaybeThenable(promise, value, getThen(value));
- } else {
- fulfill(promise, value);
- }
- }
- function publishRejection(promise) {
- if (promise._onError) {
- promise._onError(promise._result);
- }
- publish(promise);
- }
- function fulfill(promise, value) {
- if (promise._state !== PENDING) { return; }
- promise._result = value;
- promise._state = FULFILLED;
- if (promise._subscribers.length === 0) {
- if (config.instrument) {
- instrument('fulfilled', promise);
- }
- } else {
- config.async(publish, promise);
- }
- }
- function reject(promise, reason) {
- if (promise._state !== PENDING) { return; }
- promise._state = REJECTED;
- promise._result = reason;
- config.async(publishRejection, promise);
- }
- function subscribe(parent, child, onFulfillment, onRejection) {
- let subscribers = parent._subscribers;
- let length = subscribers.length;
- parent._onError = null;
- subscribers[length] = child;
- subscribers[length + FULFILLED] = onFulfillment;
- subscribers[length + REJECTED] = onRejection;
- if (length === 0 && parent._state) {
- config.async(publish, parent);
- }
- }
- function publish(promise) {
- let subscribers = promise._subscribers;
- let settled = promise._state;
- if (config.instrument) {
- instrument(settled === FULFILLED ? 'fulfilled' : 'rejected', promise);
- }
- if (subscribers.length === 0) { return; }
- let child, callback, result = promise._result;
- for (let i = 0; i < subscribers.length; i += 3) {
- child = subscribers[i];
- callback = subscribers[i + settled];
- if (child) {
- invokeCallback(settled, child, callback, result);
- } else {
- callback(result);
- }
- }
- promise._subscribers.length = 0;
- }
- function invokeCallback(state, promise, callback, result) {
- let hasCallback = typeof callback === 'function';
- let value;
- if (hasCallback) {
- value = tryCatch(callback)(result);
- } else {
- value = result;
- }
- if (promise._state !== PENDING) {
- // noop
- } else if (value === promise) {
- reject(promise, withOwnPromise());
- } else if (value === TRY_CATCH_ERROR) {
- let error = TRY_CATCH_ERROR.error;
- TRY_CATCH_ERROR.error = null; // release
- reject(promise, error);
- } else if (hasCallback) {
- resolve$1(promise, value);
- } else if (state === FULFILLED) {
- fulfill(promise, value);
- } else if (state === REJECTED) {
- reject(promise, value);
- }
- }
- function initializePromise(promise, resolver) {
- let resolved = false;
- try {
- resolver(value => {
- if (resolved) { return; }
- resolved = true;
- resolve$1(promise, value);
- }, reason => {
- if (resolved) { return; }
- resolved = true;
- reject(promise, reason);
- });
- } catch(e) {
- reject(promise, e);
- }
- }
- function then(onFulfillment, onRejection, label) {
- let parent = this;
- let state = parent._state;
- if (state === FULFILLED && !onFulfillment || state === REJECTED && !onRejection) {
- config.instrument && instrument('chained', parent, parent);
- return parent;
- }
- parent._onError = null;
- let child = new parent.constructor(noop, label);
- let result = parent._result;
- config.instrument && instrument('chained', parent, child);
- if (state === PENDING) {
- subscribe(parent, child, onFulfillment, onRejection);
- } else {
- let callback = state === FULFILLED ? onFulfillment : onRejection;
- config.async(() => invokeCallback(state, child, callback, result));
- }
- return child;
- }
- class Enumerator {
- constructor(Constructor, input, abortOnReject, label) {
- this._instanceConstructor = Constructor;
- this.promise = new Constructor(noop, label);
- this._abortOnReject = abortOnReject;
- this._isUsingOwnPromise = Constructor === Promise;
- this._isUsingOwnResolve = Constructor.resolve === resolve$$1;
- this._init(...arguments);
- }
- _init(Constructor, input) {
- let len = input.length || 0;
- this.length = len;
- this._remaining = len;
- this._result = new Array(len);
- this._enumerate(input);
- }
- _enumerate(input) {
- let length = this.length;
- let promise = this.promise;
- for (let i = 0; promise._state === PENDING && i < length; i++) {
- this._eachEntry(input[i], i, true);
- }
- this._checkFullfillment();
- }
- _checkFullfillment() {
- if (this._remaining === 0) {
- let result = this._result;
- fulfill(this.promise, result);
- this._result = null;
- }
- }
- _settleMaybeThenable(entry, i, firstPass) {
- let c = this._instanceConstructor;
- if (this._isUsingOwnResolve) {
- let then$$1 = getThen(entry);
- if (then$$1 === then && entry._state !== PENDING) {
- entry._onError = null;
- this._settledAt(entry._state, i, entry._result, firstPass);
- } else if (typeof then$$1 !== 'function') {
- this._settledAt(FULFILLED, i, entry, firstPass);
- } else if (this._isUsingOwnPromise) {
- let promise = new c(noop);
- handleMaybeThenable(promise, entry, then$$1);
- this._willSettleAt(promise, i, firstPass);
- } else {
- this._willSettleAt(new c(resolve => resolve(entry)), i, firstPass);
- }
- } else {
- this._willSettleAt(c.resolve(entry), i, firstPass);
- }
- }
- _eachEntry(entry, i, firstPass) {
- if (entry !== null && typeof entry === 'object') {
- this._settleMaybeThenable(entry, i, firstPass);
- } else {
- this._setResultAt(FULFILLED, i, entry, firstPass);
- }
- }
- _settledAt(state, i, value, firstPass) {
- let promise = this.promise;
- if (promise._state === PENDING) {
- if (this._abortOnReject && state === REJECTED) {
- reject(promise, value);
- } else {
- this._setResultAt(state, i, value, firstPass);
- this._checkFullfillment();
- }
- }
- }
- _setResultAt(state, i, value, firstPass) {
- this._remaining--;
- this._result[i] = value;
- }
- _willSettleAt(promise, i, firstPass) {
- subscribe(
- promise, undefined,
- value => this._settledAt(FULFILLED, i, value, firstPass),
- reason => this._settledAt(REJECTED, i, reason, firstPass)
- );
- }
- }
- function setSettledResult(state, i, value) {
- this._remaining--;
- if (state === FULFILLED) {
- this._result[i] = {
- state: 'fulfilled',
- value: value
- };
- } else {
- this._result[i] = {
- state: 'rejected',
- reason: value
- };
- }
- }
- /**
- `Promise.all` accepts an array of promises, and returns a new promise which
- is fulfilled with an array of fulfillment values for the passed promises, or
- rejected with the reason of the first passed promise to be rejected. It casts all
- elements of the passed iterable to promises as it runs this algorithm.
- Example:
- ```javascript
- import Promise, { resolve } from 'rsvp';
- let promise1 = resolve(1);
- let promise2 = resolve(2);
- let promise3 = resolve(3);
- let promises = [ promise1, promise2, promise3 ];
- Promise.all(promises).then(function(array){
- // The array here would be [ 1, 2, 3 ];
- });
- ```
- If any of the `promises` given to `RSVP.all` are rejected, the first promise
- that is rejected will be given as an argument to the returned promises's
- rejection handler. For example:
- Example:
- ```javascript
- import Promise, { resolve, reject } from 'rsvp';
- let promise1 = resolve(1);
- let promise2 = reject(new Error("2"));
- let promise3 = reject(new Error("3"));
- let promises = [ promise1, promise2, promise3 ];
- Promise.all(promises).then(function(array){
- // Code here never runs because there are rejected promises!
- }, function(error) {
- // error.message === "2"
- });
- ```
- @method all
- @for Promise
- @param {Array} entries array of promises
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @return {Promise} promise that is fulfilled when all `promises` have been
- fulfilled, or rejected if any of them become rejected.
- @static
- */
- function all(entries, label) {
- if (!Array.isArray(entries)) {
- return this.reject(new TypeError("Promise.all must be called with an array"), label);
- }
- return new Enumerator(this, entries, true /* abort on reject */, label).promise;
- }
- /**
- `Promise.race` returns a new promise which is settled in the same way as the
- first passed promise to settle.
- Example:
- ```javascript
- import Promise from 'rsvp';
- let promise1 = new Promise(function(resolve, reject){
- setTimeout(function(){
- resolve('promise 1');
- }, 200);
- });
- let promise2 = new Promise(function(resolve, reject){
- setTimeout(function(){
- resolve('promise 2');
- }, 100);
- });
- Promise.race([promise1, promise2]).then(function(result){
- // result === 'promise 2' because it was resolved before promise1
- // was resolved.
- });
- ```
- `Promise.race` is deterministic in that only the state of the first
- settled promise matters. For example, even if other promises given to the
- `promises` array argument are resolved, but the first settled promise has
- become rejected before the other promises became fulfilled, the returned
- promise will become rejected:
- ```javascript
- import Promise from 'rsvp';
- let promise1 = new Promise(function(resolve, reject){
- setTimeout(function(){
- resolve('promise 1');
- }, 200);
- });
- let promise2 = new Promise(function(resolve, reject){
- setTimeout(function(){
- reject(new Error('promise 2'));
- }, 100);
- });
- Promise.race([promise1, promise2]).then(function(result){
- // Code here never runs
- }, function(reason){
- // reason.message === 'promise 2' because promise 2 became rejected before
- // promise 1 became fulfilled
- });
- ```
- An example real-world use case is implementing timeouts:
- ```javascript
- import Promise from 'rsvp';
- Promise.race([ajax('foo.json'), timeout(5000)])
- ```
- @method race
- @for Promise
- @static
- @param {Array} entries array of promises to observe
- @param {String} [label] optional string for describing the promise returned.
- Useful for tooling.
- @return {Promise} a promise which settles in the same way as the first passed
- promise to settle.
- */
- function race(entries, label) {
- /*jshint validthis:true */
- let Constructor = this;
- let promise = new Constructor(noop, label);
- if (!Array.isArray(entries)) {
- reject(promise, new TypeError('Promise.race must be called with an array'));
- return promise;
- }
- for (let i = 0; promise._state === PENDING && i < entries.length; i++) {
- subscribe(
- Constructor.resolve(entries[i]), undefined,
- value => resolve$1(promise, value),
- reason => reject(promise, reason)
- );
- }
- return promise;
- }
- /**
- `Promise.reject` returns a promise rejected with the passed `reason`.
- It is shorthand for the following:
- ```javascript
- import Promise from 'rsvp';
- let promise = new Promise(function(resolve, reject){
- reject(new Error('WHOOPS'));
- });
- promise.then(function(value){
- // Code here doesn't run because the promise is rejected!
- }, function(reason){
- // reason.message === 'WHOOPS'
- });
- ```
- Instead of writing the above, your code now simply becomes the following:
- ```javascript
- import Promise from 'rsvp';
- let promise = Promise.reject(new Error('WHOOPS'));
- promise.then(function(value){
- // Code here doesn't run because the promise is rejected!
- }, function(reason){
- // reason.message === 'WHOOPS'
- });
- ```
- @method reject
- @for Promise
- @static
- @param {*} reason value that the returned promise will be rejected with.
- @param {String} [label] optional string for identifying the returned promise.
- Useful for tooling.
- @return {Promise} a promise rejected with the given `reason`.
- */
- function reject$1(reason, label) {
- /*jshint validthis:true */
- let Constructor = this;
- let promise = new Constructor(noop, label);
- reject(promise, reason);
- return promise;
- }
- const guidKey = 'rsvp_' + Date.now() + '-';
- let counter = 0;
- function needsResolver() {
- throw new TypeError('You must pass a resolver function as the first argument to the promise constructor');
- }
- function needsNew() {
- throw new TypeError("Failed to construct 'Promise': Please use the 'new' operator, this object constructor cannot be called as a function.");
- }
- /**
- Promise objects represent the eventual result of an asynchronous operation. The
- primary way of interacting with a promise is through its `then` method, which
- registers callbacks to receive either a promise’s eventual value or the reason
- why the promise cannot be fulfilled.
- Terminology
- -----------
- - `promise` is an object or function with a `then` method whose behavior conforms to this specification.
- - `thenable` is an object or function that defines a `then` method.
- - `value` is any legal JavaScript value (including undefined, a thenable, or a promise).
- - `exception` is a value that is thrown using the throw statement.
- - `reason` is a value that indicates why a promise was rejected.
- - `settled` the final resting state of a promise, fulfilled or rejected.
- A promise can be in one of three states: pending, fulfilled, or rejected.
- Promises that are fulfilled have a fulfillment value and are in the fulfilled
- state. Promises that are rejected have a rejection reason and are in the
- rejected state. A fulfillment value is never a thenable.
- Promises can also be said to *resolve* a value. If this value is also a
- promise, then the original promise's settled state will match the value's
- settled state. So a promise that *resolves* a promise that rejects will
- itself reject, and a promise that *resolves* a promise that fulfills will
- itself fulfill.
- Basic Usage:
- ------------
- ```js
- let promise = new Promise(function(resolve, reject) {
- // on success
- resolve(value);
- // on failure
- reject(reason);
- });
- promise.then(function(value) {
- // on fulfillment
- }, function(reason) {
- // on rejection
- });
- ```
- Advanced Usage:
- ---------------
- Promises shine when abstracting away asynchronous interactions such as
- `XMLHttpRequest`s.
- ```js
- function getJSON(url) {
- return new Promise(function(resolve, reject){
- let xhr = new XMLHttpRequest();
- xhr.open('GET', url);
- xhr.onreadystatechange = handler;
- xhr.responseType = 'json';
- xhr.setRequestHeader('Accept', 'application/json');
- xhr.send();
- function handler() {
- if (this.readyState === this.DONE) {
- if (this.status === 200) {
- resolve(this.response);
- } else {
- reject(new Error('getJSON: `' + url + '` failed with status: [' + this.status + ']'));
- }
- }
- };
- });
- }
- getJSON('/posts.json').then(function(json) {
- // on fulfillment
- }, function(reason) {
- // on rejection
- });
- ```
- Unlike callbacks, promises are great composable primitives.
- ```js
- Promise.all([
- getJSON('/posts'),
- getJSON('/comments')
- ]).then(function(values){
- values[0] // => postsJSON
- values[1] // => commentsJSON
- return values;
- });
- ```
- @class Promise
- @public
- @param {function} resolver
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @constructor
- */
- class Promise {
- constructor(resolver, label) {
- this._id = counter++;
- this._label = label;
- this._state = undefined;
- this._result = undefined;
- this._subscribers = [];
- config.instrument && instrument('created', this);
- if (noop !== resolver) {
- typeof resolver !== 'function' && needsResolver();
- this instanceof Promise ? initializePromise(this, resolver) : needsNew();
- }
- }
- _onError(reason) {
- config.after(() => {
- if (this._onError) {
- config.trigger('error', reason, this._label);
- }
- });
- }
- /**
- `catch` is simply sugar for `then(undefined, onRejection)` which makes it the same
- as the catch block of a try/catch statement.
- ```js
- function findAuthor(){
- throw new Error('couldn\'t find that author');
- }
- // synchronous
- try {
- findAuthor();
- } catch(reason) {
- // something went wrong
- }
- // async with promises
- findAuthor().catch(function(reason){
- // something went wrong
- });
- ```
- @method catch
- @param {Function} onRejection
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @return {Promise}
- */
- catch(onRejection, label) {
- return this.then(undefined, onRejection, label);
- }
- /**
- `finally` will be invoked regardless of the promise's fate just as native
- try/catch/finally behaves
- Synchronous example:
- ```js
- findAuthor() {
- if (Math.random() > 0.5) {
- throw new Error();
- }
- return new Author();
- }
- try {
- return findAuthor(); // succeed or fail
- } catch(error) {
- return findOtherAuthor();
- } finally {
- // always runs
- // doesn't affect the return value
- }
- ```
- Asynchronous example:
- ```js
- findAuthor().catch(function(reason){
- return findOtherAuthor();
- }).finally(function(){
- // author was either found, or not
- });
- ```
- @method finally
- @param {Function} callback
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @return {Promise}
- */
- finally(callback, label) {
- let promise = this;
- let constructor = promise.constructor;
- if (typeof callback === 'function') {
- return promise.then(value => constructor.resolve(callback()).then(() => value),
- reason => constructor.resolve(callback()).then(() => { throw reason; }));
- }
- return promise.then(callback, callback);
- }
- }
- Promise.cast = resolve$$1; // deprecated
- Promise.all = all;
- Promise.race = race;
- Promise.resolve = resolve$$1;
- Promise.reject = reject$1;
- Promise.prototype._guidKey = guidKey;
- /**
- The primary way of interacting with a promise is through its `then` method,
- which registers callbacks to receive either a promise's eventual value or the
- reason why the promise cannot be fulfilled.
- ```js
- findUser().then(function(user){
- // user is available
- }, function(reason){
- // user is unavailable, and you are given the reason why
- });
- ```
- Chaining
- --------
- The return value of `then` is itself a promise. This second, 'downstream'
- promise is resolved with the return value of the first promise's fulfillment
- or rejection handler, or rejected if the handler throws an exception.
- ```js
- findUser().then(function (user) {
- return user.name;
- }, function (reason) {
- return 'default name';
- }).then(function (userName) {
- // If `findUser` fulfilled, `userName` will be the user's name, otherwise it
- // will be `'default name'`
- });
- findUser().then(function (user) {
- throw new Error('Found user, but still unhappy');
- }, function (reason) {
- throw new Error('`findUser` rejected and we\'re unhappy');
- }).then(function (value) {
- // never reached
- }, function (reason) {
- // if `findUser` fulfilled, `reason` will be 'Found user, but still unhappy'.
- // If `findUser` rejected, `reason` will be '`findUser` rejected and we\'re unhappy'.
- });
- ```
- If the downstream promise does not specify a rejection handler, rejection reasons will be propagated further downstream.
- ```js
- findUser().then(function (user) {
- throw new PedagogicalException('Upstream error');
- }).then(function (value) {
- // never reached
- }).then(function (value) {
- // never reached
- }, function (reason) {
- // The `PedgagocialException` is propagated all the way down to here
- });
- ```
- Assimilation
- ------------
- Sometimes the value you want to propagate to a downstream promise can only be
- retrieved asynchronously. This can be achieved by returning a promise in the
- fulfillment or rejection handler. The downstream promise will then be pending
- until the returned promise is settled. This is called *assimilation*.
- ```js
- findUser().then(function (user) {
- return findCommentsByAuthor(user);
- }).then(function (comments) {
- // The user's comments are now available
- });
- ```
- If the assimliated promise rejects, then the downstream promise will also reject.
- ```js
- findUser().then(function (user) {
- return findCommentsByAuthor(user);
- }).then(function (comments) {
- // If `findCommentsByAuthor` fulfills, we'll have the value here
- }, function (reason) {
- // If `findCommentsByAuthor` rejects, we'll have the reason here
- });
- ```
- Simple Example
- --------------
- Synchronous Example
- ```javascript
- let result;
- try {
- result = findResult();
- // success
- } catch(reason) {
- // failure
- }
- ```
- Errback Example
- ```js
- findResult(function(result, err){
- if (err) {
- // failure
- } else {
- // success
- }
- });
- ```
- Promise Example;
- ```javascript
- findResult().then(function(result){
- // success
- }, function(reason){
- // failure
- });
- ```
- Advanced Example
- --------------
- Synchronous Example
- ```javascript
- let author, books;
- try {
- author = findAuthor();
- books = findBooksByAuthor(author);
- // success
- } catch(reason) {
- // failure
- }
- ```
- Errback Example
- ```js
- function foundBooks(books) {
- }
- function failure(reason) {
- }
- findAuthor(function(author, err){
- if (err) {
- failure(err);
- // failure
- } else {
- try {
- findBoooksByAuthor(author, function(books, err) {
- if (err) {
- failure(err);
- } else {
- try {
- foundBooks(books);
- } catch(reason) {
- failure(reason);
- }
- }
- });
- } catch(error) {
- failure(err);
- }
- // success
- }
- });
- ```
- Promise Example;
- ```javascript
- findAuthor().
- then(findBooksByAuthor).
- then(function(books){
- // found books
- }).catch(function(reason){
- // something went wrong
- });
- ```
- @method then
- @param {Function} onFulfillment
- @param {Function} onRejection
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @return {Promise}
- */
- Promise.prototype.then = then;
- function makeObject(_, argumentNames) {
- let obj = {};
- let length = _.length;
- let args = new Array(length);
- for (let x = 0; x < length; x++) {
- args[x] = _[x];
- }
- for (let i = 0; i < argumentNames.length; i++) {
- let name = argumentNames[i];
- obj[name] = args[i + 1];
- }
- return obj;
- }
- function arrayResult(_) {
- let length = _.length;
- let args = new Array(length - 1);
- for (let i = 1; i < length; i++) {
- args[i - 1] = _[i];
- }
- return args;
- }
- function wrapThenable(then, promise) {
- return {
- then(onFulFillment, onRejection) {
- return then.call(promise, onFulFillment, onRejection);
- }
- };
- }
- /**
- `denodeify` takes a 'node-style' function and returns a function that
- will return an `Promise`. You can use `denodeify` in Node.js or the
- browser when you'd prefer to use promises over using callbacks. For example,
- `denodeify` transforms the following:
- ```javascript
- let fs = require('fs');
- fs.readFile('myfile.txt', function(err, data){
- if (err) return handleError(err);
- handleData(data);
- });
- ```
- into:
- ```javascript
- let fs = require('fs');
- let readFile = denodeify(fs.readFile);
- readFile('myfile.txt').then(handleData, handleError);
- ```
- If the node function has multiple success parameters, then `denodeify`
- just returns the first one:
- ```javascript
- let request = denodeify(require('request'));
- request('http://example.com').then(function(res) {
- // ...
- });
- ```
- However, if you need all success parameters, setting `denodeify`'s
- second parameter to `true` causes it to return all success parameters
- as an array:
- ```javascript
- let request = denodeify(require('request'), true);
- request('http://example.com').then(function(result) {
- // result[0] -> res
- // result[1] -> body
- });
- ```
- Or if you pass it an array with names it returns the parameters as a hash:
- ```javascript
- let request = denodeify(require('request'), ['res', 'body']);
- request('http://example.com').then(function(result) {
- // result.res
- // result.body
- });
- ```
- Sometimes you need to retain the `this`:
- ```javascript
- let app = require('express')();
- let render = denodeify(app.render.bind(app));
- ```
- The denodified function inherits from the original function. It works in all
- environments, except IE 10 and below. Consequently all properties of the original
- function are available to you. However, any properties you change on the
- denodeified function won't be changed on the original function. Example:
- ```javascript
- let request = denodeify(require('request')),
- cookieJar = request.jar(); // <- Inheritance is used here
- request('http://example.com', {jar: cookieJar}).then(function(res) {
- // cookieJar.cookies holds now the cookies returned by example.com
- });
- ```
- Using `denodeify` makes it easier to compose asynchronous operations instead
- of using callbacks. For example, instead of:
- ```javascript
- let fs = require('fs');
- fs.readFile('myfile.txt', function(err, data){
- if (err) { ... } // Handle error
- fs.writeFile('myfile2.txt', data, function(err){
- if (err) { ... } // Handle error
- console.log('done')
- });
- });
- ```
- you can chain the operations together using `then` from the returned promise:
- ```javascript
- let fs = require('fs');
- let readFile = denodeify(fs.readFile);
- let writeFile = denodeify(fs.writeFile);
- readFile('myfile.txt').then(function(data){
- return writeFile('myfile2.txt', data);
- }).then(function(){
- console.log('done')
- }).catch(function(error){
- // Handle error
- });
- ```
- @method denodeify
- @public
- @static
- @for rsvp
- @param {Function} nodeFunc a 'node-style' function that takes a callback as
- its last argument. The callback expects an error to be passed as its first
- argument (if an error occurred, otherwise null), and the value from the
- operation as its second argument ('function(err, value){ }').
- @param {Boolean|Array} [options] An optional paramter that if set
- to `true` causes the promise to fulfill with the callback's success arguments
- as an array. This is useful if the node function has multiple success
- paramters. If you set this paramter to an array with names, the promise will
- fulfill with a hash with these names as keys and the success parameters as
- values.
- @return {Function} a function that wraps `nodeFunc` to return a `Promise`
- */
- function denodeify(nodeFunc, options) {
- let fn = function() {
- let l = arguments.length;
- let args = new Array(l + 1);
- let promiseInput = false;
- for (let i = 0; i < l; ++i) {
- let arg = arguments[i];
- if (!promiseInput) {
- // TODO: clean this up
- promiseInput = needsPromiseInput(arg);
- if (promiseInput === TRY_CATCH_ERROR) {
- let error = TRY_CATCH_ERROR.error;
- TRY_CATCH_ERROR.error = null;
- let p = new Promise(noop);
- reject(p, error);
- return p;
- } else if (promiseInput && promiseInput !== true) {
- arg = wrapThenable(promiseInput, arg);
- }
- }
- args[i] = arg;
- }
- let promise = new Promise(noop);
- args[l] = function(err, val) {
- if (err) {
- reject(promise, err);
- } else if (options === undefined) {
- resolve$1(promise, val);
- } else if (options === true) {
- resolve$1(promise, arrayResult(arguments));
- } else if (Array.isArray(options)) {
- resolve$1(promise, makeObject(arguments, options));
- } else {
- resolve$1(promise, val);
- }
- };
- if (promiseInput) {
- return handlePromiseInput(promise, args, nodeFunc, this);
- } else {
- return handleValueInput(promise, args, nodeFunc, this);
- }
- };
- fn.__proto__ = nodeFunc;
- return fn;
- }
- function handleValueInput(promise, args, nodeFunc, self) {
- let result = tryCatch(nodeFunc).apply(self, args);
- if (result === TRY_CATCH_ERROR) {
- let error = TRY_CATCH_ERROR.error;
- TRY_CATCH_ERROR.error = null;
- reject(promise, error);
- }
- return promise;
- }
- function handlePromiseInput(promise, args, nodeFunc, self){
- return Promise.all(args)
- .then(args => handleValueInput(promise, args, nodeFunc, self));
- }
- function needsPromiseInput(arg) {
- if (arg !== null && typeof arg === 'object') {
- if (arg.constructor === Promise) {
- return true;
- } else {
- return getThen(arg);
- }
- } else {
- return false;
- }
- }
- /**
- This is a convenient alias for `Promise.all`.
- @method all
- @public
- @static
- @for rsvp
- @param {Array} array Array of promises.
- @param {String} [label] An optional label. This is useful
- for tooling.
- */
- function all$1(array, label) {
- return Promise.all(array, label);
- }
- /**
- @module rsvp
- @public
- **/
- class AllSettled extends Enumerator {
- constructor(Constructor, entries, label) {
- super(Constructor, entries, false /* don't abort on reject */, label);
- }
- }
- AllSettled.prototype._setResultAt = setSettledResult;
- /**
- `RSVP.allSettled` is similar to `RSVP.all`, but instead of implementing
- a fail-fast method, it waits until all the promises have returned and
- shows you all the results. This is useful if you want to handle multiple
- promises' failure states together as a set.
- Returns a promise that is fulfilled when all the given promises have been
- settled. The return promise is fulfilled with an array of the states of
- the promises passed into the `promises` array argument.
- Each state object will either indicate fulfillment or rejection, and
- provide the corresponding value or reason. The states will take one of
- the following formats:
- ```javascript
- { state: 'fulfilled', value: value }
- or
- { state: 'rejected', reason: reason }
- ```
- Example:
- ```javascript
- let promise1 = RSVP.Promise.resolve(1);
- let promise2 = RSVP.Promise.reject(new Error('2'));
- let promise3 = RSVP.Promise.reject(new Error('3'));
- let promises = [ promise1, promise2, promise3 ];
- RSVP.allSettled(promises).then(function(array){
- // array == [
- // { state: 'fulfilled', value: 1 },
- // { state: 'rejected', reason: Error },
- // { state: 'rejected', reason: Error }
- // ]
- // Note that for the second item, reason.message will be '2', and for the
- // third item, reason.message will be '3'.
- }, function(error) {
- // Not run. (This block would only be called if allSettled had failed,
- // for instance if passed an incorrect argument type.)
- });
- ```
- @method allSettled
- @public
- @static
- @for rsvp
- @param {Array} entries
- @param {String} [label] - optional string that describes the promise.
- Useful for tooling.
- @return {Promise} promise that is fulfilled with an array of the settled
- states of the constituent promises.
- */
- function allSettled(entries, label) {
- if (!Array.isArray(entries)) {
- return Promise.reject(new TypeError("Promise.allSettled must be called with an array"), label);
- }
- return new AllSettled(Promise, entries, label).promise;
- }
- /**
- This is a convenient alias for `Promise.race`.
- @method race
- @public
- @static
- @for rsvp
- @param {Array} array Array of promises.
- @param {String} [label] An optional label. This is useful
- for tooling.
- */
- function race$1(array, label) {
- return Promise.race(array, label);
- }
- class PromiseHash extends Enumerator {
- constructor(Constructor, object, abortOnReject = true, label) {
- super(Constructor, object, abortOnReject, label);
- }
- _init(Constructor, object) {
- this._result = {};
- this._enumerate(object);
- }
- _enumerate(input) {
- let keys = Object.keys(input);
- let length = keys.length;
- let promise = this.promise;
- this._remaining = length;
- let key, val;
- for (let i = 0; promise._state === PENDING && i < length; i++) {
- key = keys[i];
- val = input[key];
- this._eachEntry(val, key, true);
- }
- this._checkFullfillment();
- }
- }
- /**
- `hash` is similar to `all`, but takes an object instead of an array
- for its `promises` argument.
- Returns a promise that is fulfilled when all the given promises have been
- fulfilled, or rejected if any of them become rejected. The returned promise
- is fulfilled with a hash that has the same key names as the `promises` object
- argument. If any of the values in the object are not promises, they will
- simply be copied over to the fulfilled object.
- Example:
- ```javascript
- let promises = {
- myPromise: resolve(1),
- yourPromise: resolve(2),
- theirPromise: resolve(3),
- notAPromise: 4
- };
- hash(promises).then(function(hash){
- // hash here is an object that looks like:
- // {
- // myPromise: 1,
- // yourPromise: 2,
- // theirPromise: 3,
- // notAPromise: 4
- // }
- });
- ```
- If any of the `promises` given to `hash` are rejected, the first promise
- that is rejected will be given as the reason to the rejection handler.
- Example:
- ```javascript
- let promises = {
- myPromise: resolve(1),
- rejectedPromise: reject(new Error('rejectedPromise')),
- anotherRejectedPromise: reject(new Error('anotherRejectedPromise')),
- };
- hash(promises).then(function(hash){
- // Code here never runs because there are rejected promises!
- }, function(reason) {
- // reason.message === 'rejectedPromise'
- });
- ```
- An important note: `hash` is intended for plain JavaScript objects that
- are just a set of keys and values. `hash` will NOT preserve prototype
- chains.
- Example:
- ```javascript
- import { hash, resolve } from 'rsvp';
- function MyConstructor(){
- this.example = resolve('Example');
- }
- MyConstructor.prototype = {
- protoProperty: resolve('Proto Property')
- };
- let myObject = new MyConstructor();
- hash(myObject).then(function(hash){
- // protoProperty will not be present, instead you will just have an
- // object that looks like:
- // {
- // example: 'Example'
- // }
- //
- // hash.hasOwnProperty('protoProperty'); // false
- // 'undefined' === typeof hash.protoProperty
- });
- ```
- @method hash
- @public
- @static
- @for rsvp
- @param {Object} object
- @param {String} [label] optional string that describes the promise.
- Useful for tooling.
- @return {Promise} promise that is fulfilled when all properties of `promises`
- have been fulfilled, or rejected if any of them become rejected.
- */
- function hash(object, label) {
- return Promise.resolve(object, label)
- .then(function(object) {
- if (object === null || typeof object !== 'object') {
- throw new TypeError("Promise.hash must be called with an object");
- }
- return new PromiseHash(Promise, object, label).promise;
- });
- }
- class HashSettled extends PromiseHash {
- constructor(Constructor, object, label) {
- super(Constructor, object, false, label);
- }
- }
- HashSettled.prototype._setResultAt = setSettledResult;
- /**
- `hashSettled` is similar to `allSettled`, but takes an object
- instead of an array for its `promises` argument.
- Unlike `all` or `hash`, which implement a fail-fast method,
- but like `allSettled`, `hashSettled` waits until all the
- constituent promises have returned and then shows you all the results
- with their states and values/reasons. This is useful if you want to
- handle multiple promises' failure states together as a set.
- Returns a promise that is fulfilled when all the given promises have been
- settled, or rejected if the passed parameters are invalid.
- The returned promise is fulfilled with a hash that has the same key names as
- the `promises` object argument. If any of the values in the object are not
- promises, they will be copied over to the fulfilled object and marked with state
- 'fulfilled'.
- Example:
- ```javascript
- import { hashSettled, resolve } from 'rsvp';
- let promises = {
- myPromise: resolve(1),
- yourPromise: resolve(2),
- theirPromise: resolve(3),
- notAPromise: 4
- };
- hashSettled(promises).then(function(hash){
- // hash here is an object that looks like:
- // {
- // myPromise: { state: 'fulfilled', value: 1 },
- // yourPromise: { state: 'fulfilled', value: 2 },
- // theirPromise: { state: 'fulfilled', value: 3 },
- // notAPromise: { state: 'fulfilled', value: 4 }
- // }
- });
- ```
- If any of the `promises` given to `hash` are rejected, the state will
- be set to 'rejected' and the reason for rejection provided.
- Example:
- ```javascript
- import { hashSettled, reject, resolve } from 'rsvp';
- let promises = {
- myPromise: resolve(1),
- rejectedPromise: reject(new Error('rejection')),
- anotherRejectedPromise: reject(new Error('more rejection')),
- };
- hashSettled(promises).then(function(hash){
- // hash here is an object that looks like:
- // {
- // myPromise: { state: 'fulfilled', value: 1 },
- // rejectedPromise: { state: 'rejected', reason: Error },
- // anotherRejectedPromise: { state: 'rejected', reason: Error },
- // }
- // Note that for rejectedPromise, reason.message == 'rejection',
- // and for anotherRejectedPromise, reason.message == 'more rejection'.
- });
- ```
- An important note: `hashSettled` is intended for plain JavaScript objects that
- are just a set of keys and values. `hashSettled` will NOT preserve prototype
- chains.
- Example:
- ```javascript
- import Promise, { hashSettled, resolve } from 'rsvp';
- function MyConstructor(){
- this.example = resolve('Example');
- }
- MyConstructor.prototype = {
- protoProperty: Promise.resolve('Proto Property')
- };
- let myObject = new MyConstructor();
- hashSettled(myObject).then(function(hash){
- // protoProperty will not be present, instead you will just have an
- // object that looks like:
- // {
- // example: { state: 'fulfilled', value: 'Example' }
- // }
- //
- // hash.hasOwnProperty('protoProperty'); // false
- // 'undefined' === typeof hash.protoProperty
- });
- ```
- @method hashSettled
- @public
- @for rsvp
- @param {Object} object
- @param {String} [label] optional string that describes the promise.
- Useful for tooling.
- @return {Promise} promise that is fulfilled when when all properties of `promises`
- have been settled.
- @static
- */
- function hashSettled(object, label) {
- return Promise.resolve(object, label)
- .then(function(object) {
- if (object === null || typeof object !== 'object') {
- throw new TypeError("hashSettled must be called with an object");
- }
- return new HashSettled(Promise, object, false, label).promise;
- });
- }
- /**
- `rethrow` will rethrow an error on the next turn of the JavaScript event
- loop in order to aid debugging.
- Promises A+ specifies that any exceptions that occur with a promise must be
- caught by the promises implementation and bubbled to the last handler. For
- this reason, it is recommended that you always specify a second rejection
- handler function to `then`. However, `rethrow` will throw the exception
- outside of the promise, so it bubbles up to your console if in the browser,
- or domain/cause uncaught exception in Node. `rethrow` will also throw the
- error again so the error can be handled by the promise per the spec.
- ```javascript
- import { rethrow } from 'rsvp';
- function throws(){
- throw new Error('Whoops!');
- }
- let promise = new Promise(function(resolve, reject){
- throws();
- });
- promise.catch(rethrow).then(function(){
- // Code here doesn't run because the promise became rejected due to an
- // error!
- }, function (err){
- // handle the error here
- });
- ```
- The 'Whoops' error will be thrown on the next turn of the event loop
- and you can watch for it in your console. You can also handle it using a
- rejection handler given to `.then` or `.catch` on the returned promise.
- @method rethrow
- @public
- @static
- @for rsvp
- @param {Error} reason reason the promise became rejected.
- @throws Error
- @static
- */
- function rethrow(reason) {
- setTimeout(() => {
- throw reason;
- });
- throw reason;
- }
- /**
- `defer` returns an object similar to jQuery's `$.Deferred`.
- `defer` should be used when porting over code reliant on `$.Deferred`'s
- interface. New code should use the `Promise` constructor instead.
- The object returned from `defer` is a plain object with three properties:
- * promise - an `Promise`.
- * reject - a function that causes the `promise` property on this object to
- become rejected
- * resolve - a function that causes the `promise` property on this object to
- become fulfilled.
- Example:
- ```javascript
- let deferred = defer();
- deferred.resolve("Success!");
- deferred.promise.then(function(value){
- // value here is "Success!"
- });
- ```
- @method defer
- @public
- @static
- @for rsvp
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @return {Object}
- */
- function defer(label) {
- let deferred = { resolve: undefined, reject: undefined };
- deferred.promise = new Promise((resolve, reject) => {
- deferred.resolve = resolve;
- deferred.reject = reject;
- }, label);
- return deferred;
- }
- class MapEnumerator extends Enumerator {
- constructor(Constructor, entries, mapFn, label) {
- super(Constructor, entries, true, label, mapFn);
- }
- _init(Constructor, input, bool, label, mapFn) {
- let len = input.length || 0;
- this.length = len;
- this._remaining = len;
- this._result = new Array(len);
- this._mapFn = mapFn;
- this._enumerate(input);
- }
- _setResultAt(state, i, value, firstPass) {
- if (firstPass) {
- let val = tryCatch(this._mapFn)(value, i);
- if (val === TRY_CATCH_ERROR) {
- this._settledAt(REJECTED, i, val.error, false);
- } else {
- this._eachEntry(val, i, false);
- }
- } else {
- this._remaining--;
- this._result[i] = value;
- }
- }
- }
- /**
- `map` is similar to JavaScript's native `map` method. `mapFn` is eagerly called
- meaning that as soon as any promise resolves its value will be passed to `mapFn`.
- `map` returns a promise that will become fulfilled with the result of running
- `mapFn` on the values the promises become fulfilled with.
- For example:
- ```javascript
- import { map, resolve } from 'rsvp';
- let promise1 = resolve(1);
- let promise2 = resolve(2);
- let promise3 = resolve(3);
- let promises = [ promise1, promise2, promise3 ];
- let mapFn = function(item){
- return item + 1;
- };
- map(promises, mapFn).then(function(result){
- // result is [ 2, 3, 4 ]
- });
- ```
- If any of the `promises` given to `map` are rejected, the first promise
- that is rejected will be given as an argument to the returned promise's
- rejection handler. For example:
- ```javascript
- import { map, reject, resolve } from 'rsvp';
- let promise1 = resolve(1);
- let promise2 = reject(new Error('2'));
- let promise3 = reject(new Error('3'));
- let promises = [ promise1, promise2, promise3 ];
- let mapFn = function(item){
- return item + 1;
- };
- map(promises, mapFn).then(function(array){
- // Code here never runs because there are rejected promises!
- }, function(reason) {
- // reason.message === '2'
- });
- ```
- `map` will also wait if a promise is returned from `mapFn`. For example,
- say you want to get all comments from a set of blog posts, but you need
- the blog posts first because they contain a url to those comments.
- ```javscript
- import { map } from 'rsvp';
- let mapFn = function(blogPost){
- // getComments does some ajax and returns an Promise that is fulfilled
- // with some comments data
- return getComments(blogPost.comments_url);
- };
- // getBlogPosts does some ajax and returns an Promise that is fulfilled
- // with some blog post data
- map(getBlogPosts(), mapFn).then(function(comments){
- // comments is the result of asking the server for the comments
- // of all blog posts returned from getBlogPosts()
- });
- ```
- @method map
- @public
- @static
- @for rsvp
- @param {Array} promises
- @param {Function} mapFn function to be called on each fulfilled promise.
- @param {String} [label] optional string for labeling the promise.
- Useful for tooling.
- @return {Promise} promise that is fulfilled with the result of calling
- `mapFn` on each fulfilled promise or value when they become fulfilled.
- The promise will be rejected if any of the given `promises` become rejected.
- */
- function map(promises, mapFn, label) {
- if (typeof mapFn !== 'function') {
- return Promise.reject(new TypeError("map expects a function as a second argument"), label);
- }
- return Promise.resolve(promises, label)
- .then(function(promises) {
- if (!Array.isArray(promises)) {
- throw new TypeError("map must be called with an array");
- }
- return new MapEnumerator(Promise, promises, mapFn, label).promise;
- });
- }
- /**
- This is a convenient alias for `Promise.resolve`.
- @method resolve
- @public
- @static
- @for rsvp
- @param {*} value value that the returned promise will be resolved with
- @param {String} [label] optional string for identifying the returned promise.
- Useful for tooling.
- @return {Promise} a promise that will become fulfilled with the given
- `value`
- */
- function resolve$2(value, label) {
- return Promise.resolve(value, label);
- }
- /**
- This is a convenient alias for `Promise.reject`.
- @method reject
- @public
- @static
- @for rsvp
- @param {*} reason value that the returned promise will be rejected with.
- @param {String} [label] optional string for identifying the returned promise.
- Useful for tooling.
- @return {Promise} a promise rejected with the given `reason`.
- */
- function reject$2(reason, label) {
- return Promise.reject(reason, label);
- }
- const EMPTY_OBJECT = {};
- class FilterEnumerator extends MapEnumerator {
- _checkFullfillment() {
- if (this._remaining === 0 && this._result !== null) {
- let result = this._result.filter((val) => val !== EMPTY_OBJECT);
- fulfill(this.promise, result);
- this._result = null;
- }
- }
- _setResultAt(state, i, value, firstPass) {
- if (firstPass) {
- this._result[i] = value;
- let val = tryCatch(this._mapFn)(value, i);
- if (val === TRY_CATCH_ERROR) {
- this._settledAt(REJECTED, i, val.error, false);
- } else {
- this._eachEntry(val, i, false);
- }
- } else {
- this._remaining--;
- if (!value) {
- this._result[i] = EMPTY_OBJECT;
- }
- }
- }
- }
- /**
- `filter` is similar to JavaScript's native `filter` method.
- `filterFn` is eagerly called meaning that as soon as any promise
- resolves its value will be passed to `filterFn`. `filter` returns
- a promise that will become fulfilled with the result of running
- `filterFn` on the values the promises become fulfilled with.
- For example:
- ```javascript
- import { filter, resolve } from 'rsvp';
- let promise1 = resolve(1);
- let promise2 = resolve(2);
- let promise3 = resolve(3);
- let promises = [promise1, promise2, promise3];
- let filterFn = function(item){
- return item > 1;
- };
- filter(promises, filterFn).then(function(result){
- // result is [ 2, 3 ]
- });
- ```
- If any of the `promises` given to `filter` are rejected, the first promise
- that is rejected will be given as an argument to the returned promise's
- rejection handler. For example:
- ```javascript
- import { filter, reject, resolve } from 'rsvp';
- let promise1 = resolve(1);
- let promise2 = reject(new Error('2'));
- let promise3 = reject(new Error('3'));
- let promises = [ promise1, promise2, promise3 ];
- let filterFn = function(item){
- return item > 1;
- };
- filter(promises, filterFn).then(function(array){
- // Code here never runs because there are rejected promises!
- }, function(reason) {
- // reason.message === '2'
- });
- ```
- `filter` will also wait for any promises returned from `filterFn`.
- For instance, you may want to fetch a list of users then return a subset
- of those users based on some asynchronous operation:
- ```javascript
- import { filter, resolve } from 'rsvp';
- let alice = { name: 'alice' };
- let bob = { name: 'bob' };
- let users = [ alice, bob ];
- let promises = users.map(function(user){
- return resolve(user);
- });
- let filterFn = function(user){
- // Here, Alice has permissions to create a blog post, but Bob does not.
- return getPrivilegesForUser(user).then(function(privs){
- return privs.can_create_blog_post === true;
- });
- };
- filter(promises, filterFn).then(function(users){
- // true, because the server told us only Alice can create a blog post.
- users.length === 1;
- // false, because Alice is the only user present in `users`
- users[0] === bob;
- });
- ```
- @method filter
- @public
- @static
- @for rsvp
- @param {Array} promises
- @param {Function} filterFn - function to be called on each resolved value to
- filter the final results.
- @param {String} [label] optional string describing the promise. Useful for
- tooling.
- @return {Promise}
- */
- function filter(promises, filterFn, label) {
- if (typeof filterFn !== 'function') {
- return Promise.reject(new TypeError("filter expects function as a second argument"), label);
- }
- return Promise.resolve(promises, label)
- .then(function(promises) {
- if (!Array.isArray(promises)) {
- throw new TypeError("filter must be called with an array");
- }
- return new FilterEnumerator(Promise, promises, filterFn, label).promise;
- });
- }
- let len = 0;
- let vertxNext;
- function asap(callback, arg) {
- queue$1[len] = callback;
- queue$1[len + 1] = arg;
- len += 2;
- if (len === 2) {
- // If len is 1, that means that we need to schedule an async flush.
- // If additional callbacks are queued before the queue is flushed, they
- // will be processed by this flush that we are scheduling.
- scheduleFlush$1();
- }
- }
- const browserWindow = (typeof window !== 'undefined') ? window : undefined;
- const browserGlobal = browserWindow || {};
- const BrowserMutationObserver = browserGlobal.MutationObserver || browserGlobal.WebKitMutationObserver;
- const isNode = typeof self === 'undefined' &&
- typeof process !== 'undefined' && {}.toString.call(process) === '[object process]';
- // test for web worker but not in IE10
- const isWorker = typeof Uint8ClampedArray !== 'undefined' &&
- typeof importScripts !== 'undefined' &&
- typeof MessageChannel !== 'undefined';
- // node
- function useNextTick() {
- let nextTick = process.nextTick;
- // node version 0.10.x displays a deprecation warning when nextTick is used recursively
- // setImmediate should be used instead instead
- let version = process.versions.node.match(/^(?:(\d+)\.)?(?:(\d+)\.)?(\*|\d+)$/);
- if (Array.isArray(version) && version[1] === '0' && version[2] === '10') {
- nextTick = setImmediate;
- }
- return () => nextTick(flush);
- }
- // vertx
- function useVertxTimer() {
- if (typeof vertxNext !== 'undefined') {
- return function() {
- vertxNext(flush);
- };
- }
- return useSetTimeout();
- }
- function useMutationObserver() {
- let iterations = 0;
- let observer = new BrowserMutationObserver(flush);
- let node = document.createTextNode('');
- observer.observe(node, { characterData: true });
- return () => node.data = (iterations = ++iterations % 2);
- }
- // web worker
- function useMessageChannel() {
- let channel = new MessageChannel();
- channel.port1.onmessage = flush;
- return () => channel.port2.postMessage(0);
- }
- function useSetTimeout() {
- return () => setTimeout(flush, 1);
- }
- const queue$1 = new Array(1000);
- function flush() {
- for (let i = 0; i < len; i+=2) {
- let callback = queue$1[i];
- let arg = queue$1[i+1];
- callback(arg);
- queue$1[i] = undefined;
- queue$1[i+1] = undefined;
- }
- len = 0;
- }
- function attemptVertex() {
- try {
- const vertx = Function('return this')().require('vertx');
- vertxNext = vertx.runOnLoop || vertx.runOnContext;
- return useVertxTimer();
- } catch(e) {
- return useSetTimeout();
- }
- }
- let scheduleFlush$1;
- // Decide what async method to use to triggering processing of queued callbacks:
- if (isNode) {
- scheduleFlush$1 = useNextTick();
- } else if (BrowserMutationObserver) {
- scheduleFlush$1 = useMutationObserver();
- } else if (isWorker) {
- scheduleFlush$1 = useMessageChannel();
- } else if (browserWindow === undefined && typeof require === 'function') {
- scheduleFlush$1 = attemptVertex();
- } else {
- scheduleFlush$1 = useSetTimeout();
- }
- // defaults
- config.async = asap;
- config.after = cb => setTimeout(cb, 0);
- const cast = resolve$2;
- const async = (callback, arg) => config.async(callback, arg);
- function on() {
- config.on(...arguments);
- }
- function off() {
- config.off(...arguments);
- }
- // Set up instrumentation through `window.__PROMISE_INTRUMENTATION__`
- if (typeof window !== 'undefined' && typeof window['__PROMISE_INSTRUMENTATION__'] === 'object') {
- let callbacks = window['__PROMISE_INSTRUMENTATION__'];
- configure('instrument', true);
- for (let eventName in callbacks) {
- if (callbacks.hasOwnProperty(eventName)) {
- on(eventName, callbacks[eventName]);
- }
- }
- }
- // the default export here is for backwards compat:
- // https://github.com/tildeio/rsvp.js/issues/434
- var rsvp = {
- asap,
- cast,
- Promise,
- EventTarget,
- all: all$1,
- allSettled,
- race: race$1,
- hash,
- hashSettled,
- rethrow,
- defer,
- denodeify,
- configure,
- on,
- off,
- resolve: resolve$2,
- reject: reject$2,
- map,
- async,
- filter
- };
- export default rsvp;
- export { asap, cast, Promise, EventTarget, all$1 as all, allSettled, race$1 as race, hash, hashSettled, rethrow, defer, denodeify, configure, on, off, resolve$2 as resolve, reject$2 as reject, map, async, filter };
- //# sourceMappingURL=rsvp.es.map
|