Deferred技术文档

1. 安装指南

根据项目需求，Deferred的安装方式有两种：NPM安装和浏览器环境下的安装。

NPM安装

在你的项目路径下执行以下命令：

$ npm install deferred

浏览器环境安装

在浏览器环境下，可以使用modules-webmake工具来创建一个Bundle。假设你已经安装了最新的Node.js和Git，以下命令在任意系统的命令行中均有效（Linux/MacOS/Windows）：

$ npm install -g webmake
$ git clone git://github.com/medikoo/deferred.git
$ cd deferred
$ npm install
$ cd ..
$ webmake --name=deferred deferred/index.js deferred.js

最后一条命令会将Deferred及其所有功能模块打包在一起，但如果你的项目只需要部分功能，你可以通过指定模块来创建一个更小的Bundle。

2. 项目的使用说明

Deferred是一个模块化和快速的JavaScript承诺（Promise）实现。使用Deferred，你可以编写清晰且易于维护的代码，充分利用异步编程的优势。Deferred支持承诺的链式调用和嵌套，强制你以声明式的方式编程。

Deferred的主要特点包括：

• 处理承诺调用集合
• 处理Node.js异步函数
• 限制任务并发数
• 触发进度事件或部分流式传输结果
• 跟踪未解决的承诺或收集使用统计信息

3. 项目API使用文档

Deferred API主要包括以下功能：

• promisify(fn[, length]): 将Node.js风格的回调函数转换为返回Promise的函数。
• defer(): 创建一个新的Deferred对象，包含一个Promise和一个resolve方法。
• isPromise(obj): 判断一个对象是否是Promise。

具体的使用方法和示例代码，可以参考项目中的examples文件夹。

示例

以下是一个简单的使用Deferred来异步延迟执行函数的例子：

var deferred = require('deferred');

var delay = function (fn, timeout) {
  return function () {
    var def = deferred(), self = this, args = arguments;

    setTimeout(function () {
      var value;
      try {
        value = fn.apply(self, args);
      } catch (e) {
        def.reject(e);
        return;
      }
      def.resolve(value);
    }, timeout);

    return def.promise;
  };
};

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明。简要概括，可以通过NPM在Node.js环境中安装，也可以通过构建工具在浏览器环境中创建一个Bundle。

在Node.js环境下，使用以下命令：

$ npm install deferred

在浏览器环境中，使用以下命令构建：

$ npm install -g webmake
$ git clone git://github.com/medikoo/deferred.git
$ cd deferred
$ npm install
$ cd ..
$ webmake --name=deferred deferred/index.js deferred.js