Simply Deferred 技术文档

1. 安装指南

首先，确保您的环境中已经安装了Node.js。然后，您可以通过以下命令来安装 Simply Deferred：

npm install simply-deferred

此命令会在当前目录的 node_modules 文件夹中安装 Simply Deferred，并在全局范围内添加 simply-deferred 软链接。

2. 项目的使用说明

Simply Deferred 是一个类似于 jQuery 的延时（Deferred）API，适用于 Node.js 和浏览器环境。其 API 完全兼容 jQuery，因此您可以直接使用 jQuery 的文档和用法。

以下是一个简单的使用示例：

var Deferred = require('simply-deferred').Deferred;
var rendering = new Deferred();

// 当渲染完成时调用
rendering.done(function(){
    console.log('渲染完成');
});

// ...

// 触发渲染完成的动作
rendering.resolve();

在上面的代码中，我们创建了一个 Deferred 对象，并在其上注册了一个完成（done）回调函数。当调用 resolve 方法时，会触发这个回调函数。

3. 项目API使用文档

Simply Deferred 提供了以下方法，它们与 jQuery 的 Deferred API 完全相同：

• Deferred() - 创建一个延期对象。
• deferred.state() - 返回当前对象的状态。
• deferred.done() - 当对象成功完成时，添加一个回调函数到 done 列表。
• deferred.fail() - 当对象失败时，添加一个回调函数到 fail 列表。
• deferred.progress() - 当对象进度更新时，添加一个回调函数到 progress 列表。
• deferred.always() - 无论对象成功还是失败，都添加一个回调函数到 always 列表。
• deferred.promise() - 返回一个对象，它具有 done()、fail() 和 always() 等方法，但不具有 resolve()、reject() 或 notify() 方法。
• deferred.notify() - 触发 progress 回调。
• deferred.notifyWith() - 与 notify 类似，但允许您指定上下文和参数。
• deferred.resolve() - 完成延迟对象，触发 done 回调。
• deferred.resolveWith() - 与 resolve 类似，但允许您指定上下文和参数。
• deferred.reject() - 拒绝延迟对象，触发 fail 回调。
• deferred.rejectWith() - 与 reject 类似，但允许您指定上下文和参数。
• deferred.pipe() - 通过转换延迟对象的结果来创建一个新的延迟对象。
• deferred.then() - 为延迟对象添加 done 和 fail 回调。
• Deferred.when() - 当多个延迟对象都完成时，调用回调。

4. 项目安装方式

Simply Deferred 的安装方式非常简单，只需要使用 npm 命令即可：

npm install simply-deferred

确保在执行此命令之前已经安装了 Node.js。安装完成后，您就可以在项目中使用 Simply Deferred 库了。