When.js 技术文档

1. 安装指南

When.js 支持 AMD、CommonJS/Node 等多种环境。以下是不同环境下的安装方式：

AMD 环境

通过 bower 安装，或者直接克隆仓库，从根目录加载 when.js。

bower install --save when

CommonJS/Node 环境

使用 npm 进行安装。

npm install --save when

更多帮助以及其他环境的安装方式，请参考 安装文档。

2. 项目使用说明

Promises 可以用来简化管理和嵌套的回调流程。以下是一些使用示例（采用 commonjs 环境）。

示例一

以下示例在一切顺利的情况下将打印 "hello world!!!!"，如果有问题则会打印 "drat!"。同时使用 rest 来向一个（虚构的）外部服务发起 AJAX 请求。

var rest = require('rest');

fetchRemoteGreeting()
    .then(addExclamation)
    .catch(handleError)
    .done(function(greeting) {
        console.log(greeting);
    });

function fetchRemoteGreeting() {
    var result = rest('http://example.com/greeting');
    return when(result);
}

function addExclamation(greeting) {
    return greeting + '!!!!';
}

function handleError(e) {
    return 'drat!';
}

示例二

以下示例展示了 when 的 Promise 逻辑的强大功能。这里，我们从远程源获取一个数字数组并进行累加。如果一切顺利，将打印 150；如果有问题，将打印完整的堆栈跟踪。

var when = require('when');
var rest = require('rest');

when.reduce(when.map(getRemoteNumberList(), times10), sum)
    .done(function(result) {
        console.log(result);
    });

function getRemoteNumberList() {
    return rest('http://example.com/numbers').then(JSON.parse);
}

function sum(x, y) { return x + y; }
function times10(x) { return x * 10; }

3. 项目API使用文档

关于 When.js 的 API 文档，请参考 API 文档。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明，支持 AMD 和 CommonJS/Node 等多种环境。

---

本项目遵循 MIT 许可。更多信息请查看 完整许可。贡献指南请参考 贡献文档。