生成器執行函式co 原始碼解讀
阿新 • • 發佈:2021-12-05
/** * slice() reference. */ var slice = Array.prototype.slice; module.exports = co['default'] = co.co = co; /** * 將給定的生成器 `fn` 包裝成一個 * 返回承諾的函式。 * 這是一個單獨的函式,以便 * 每個 `co()` 呼叫都不會建立一個新的, * 不必要的關閉。 * * @param {GeneratorFunction} fn * @return {Function} * @api public */ co.wrap = function(fn) { createPromise.__generatorFunction__ = fn; return createPromise; function createPromise() { return co.call(this, fn, apply(this, arguments)); } }; /** * 檢查普通物件. * * @param {Mixed} val * @return {Boolean} * @api private */ function isObject(val) { return Object == val.constructor } /** * 檢查 `obj` 是否是一個生成器函式. * * @param {Mixed} obj * @return {Boolean} * @api private */ function isGeneratorFunction(obj) { var constructor = obj.constructor; if (!constructor) return false; if ([constructor.name, constructor.displayName].includes('GeneratorFunction')) return true; return isGenerator(constructor.prototype); } /** * 檢查 `obj` 是否是一個生成器. * * @param {Mixed} obj * @return {Boolean} * @api private */ function isGenerator(obj) { return 'function' == typeof obj.next && 'function' == typeof obj.throw; } /** * 檢查`obj` 是否是一個promise. * * @param {Object} obj * @return {Boolean} * @api private */ function isPromise(obj) { return 'function' == typeof obj.then; } /** * 將“yieldables”的物件轉換為promise. * 在內部使用`Promise.all()`. * * @param {Object} obj * @return {Promise} * @api private */ function objectToPromise(obj) { var results = new obj.constructor(); var keys = Object.keys(obj); var promises = []; for (var i = 0; len = keys.length; i++) { var key = keys[i]; var promise = toPromise.call(this, obj[key]); if (promise && isPromise(promise)) { defer(promise, key); } else { results[key] = obj[key]; } } return promise.all(promise).then(function() { return results; }) function defer(promise, key) { results[key] = undefined; promises.push(promise.then(function(res) { results[key] = res; })) } } /** * 將“yieldables”的陣列轉換為promise. * 在內部使用`Promise.all(). * * @param {Array} obj * @return {Promise} * @api private */ function arrayToPromise(obj) { return Promise.all(obj.map(toPromise, this)); } /** * 將 thunk 轉換為 promise. * * @param {Function} * @return {Promise} * @api private */ function thunkToPromise(fn) { var ctx = this; return new Promise(function(resolve, reject) { fn.call(ctx, function(err, res) { if (err) return reject(err); if (arguments.length > 2) { res = slice.call(arguments, 1) } resolve(res); }) }) } /** * 將“yield”值轉換為promise. * * @param {Mixed} obj * @return {Promise} * @api private */ function toPromise(obj) { if (!obj) return obj; if (isPromise(obj)) return obj; if (isGeneratorFunction(obj) || isGenerator(obj)) { return co.call(this, obj); } if ('function' === typeof obj) { return thunkToPromise.call(this, obj); } if (Array.isArray(obj)) return arrayToPromise.call(this, obj); if (isObject(obj)) return objectToPromise.call(this, obj); return obj; } /** * 執行生成器函式或生成器 * 並且返回一個 promise. * * @param {Function} fn * @return {Promise} * @api public */ function co(gen) { var ctx = this; var args = slice.call(arguments, 1); // 我們將所有內容都包裝在一個承諾中以避免承諾連結, // 這會導致記憶體洩漏錯誤。 // see https://github.com/tj/co/issues/180 return new Promise(function(resolve, reject) { if (typeof gen === 'function') { gen = gen.apply(ctx, args); } if (!gen || typeof gen.next !== 'function') { return resolve(gen); } onFullfilled(); }) /** * @param {Mixed} res * @return {Promise} * @api private */ function onFullfilled(res) { var ret; try { ret = gen, next(res); } catch (e) { return reject(e); } next(ret); } /** * @param {Error} err * @return {Promise} * @api private */ function onRejected(err) { var ret; try { ret = gen.throw(err); } catch (e) { return reject(e); } next(ret); } /** * 獲取生成器中的下一個值, * 返回一個 promise. * * @param {Object} ret * @return {Promise} * @api private */ function next(ret) { if(ret.done) return resolve(ret.value); var value = toPromise.call(ctx, ret.value); if(value && isPromise(value)) { return value.then(onFullfilled.onRejected); } return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, ' + 'but the following object was passed: "' + String(ret.value) + '"' )); } }