Streamline.js 技术文档

1. 安装指南

streamline.js 是一个简化异步 JavaScript 编程的语言工具。安装方法如下：

使用 NPM 进行全局安装：

npm install streamline -g

如果遇到 UNIX 系统的权限错误，请使用 sudo 重新尝试安装。

注意：在安装过程中可能会遇到错误，因为 fibers 现在作为可选包安装，并且可能无法构建。但这个包是可选的，streamline 本身应该可以正常安装。

2. 项目使用说明

streamline.js 允许你以同步方式编写异步代码，只需将所有回调函数的参数替换为一个下划线 _。这样，你就可以按照同步代码的方式来编写异步逻辑。

以下是一个简化的例子：

function archiveOrders(date, _) {
  var conn = db.connect(_);
  conn.query("select * from orders where date < ?", [date], _).forEach_(_, function(_, order) {
    conn.execute("insert into archivedOrders ...", [order.id, ...], _);
    conn.execute("delete from orders where id=?", [order.id], _);
  });
  console.log("orders have been archived");
}

streamline.js 会自动处理回调，你不需要手动编写它们。

3. 项目 API 使用文档

streamline.js 提供了以下主要 API 和功能：

• 使用 _ 替换回调参数，以同步方式编写异步代码。
• 支持条件语句、循环、try/catch/finally 块、匿名函数、链式调用、this 等 JavaScript 特性。
• 提供 _futures，用于异步操作的未来结果。
• 提供异步数组的扩展函数，如 forEach_、map_、filter_、reduce_ 等。

4. 项目安装方式

streamline.js 可以通过以下两种方式安装：

• 全局安装：使用 NPM 全局安装，使 _node 和 _coffee 命令可用。

npm install streamline -g

• 本地安装：在不使用 -g 的情况下安装，但 _node 和 _coffee 命令不会在默认路径中。

npm install streamline

在开发过程中推荐使用加载器，而在部署时推荐预编译文件。

运行时依赖：运行时库作为单独的 streamline-runtime 包提供。如果部署预编译文件，只需 streamline-runtime。如果使用加载器，则需要同时部署 streamline-runtime 和 streamline。

浏览器端使用：可以通过 browserify 转换和捆绑文件，或使用 transform API 在浏览器中转换代码。

生成选项：可以针对不同的运行时环境（回调、fibers、生成器、await）转换代码。选择哪种运行时取决于性能基准。

与标准 Node.js 代码的互操作性：可以无缝调用标准的 Node.js 异步函数，并将 Streamline 函数作为标准 Node.js 函数调用。

与 Promise 的互操作性：Streamline 支持与 Promise 库的无缝互操作。

Futures：Streamline 提供 Futures，用于简化异步操作的并行处理。

异步数组函数：Streamline 扩展了 Array 原型，提供了异步版本的 ES5 数组函数。