npm 包 runner-js 使用教程

前言

runner-js 是一个基于 Promise 封装的 JavaScript 运行器，它可以让你方便地运行一组 JavaScript 任务。无论是在前端还是在 Node 环境下，如果你需要同时运行多个 JavaScript 任务，并且需要用 Promise 等待它们全部完成，那么 runner-js 就是一个非常不错的选择。

安装

你可以通过 npm 将 runner-js 安装到你的项目中：

npm install runner-js

使用方法

使用 runner-js，你需要做以下三件事：

1. 首先创建一个 runner 实例；
2. 然后添加一组 JavaScript 任务；
3. 最后运行这些任务。

下面我们将详细说明如何执行这些步骤。

创建 runner 实例

const { Runner } = require('runner-js');

const runner = new Runner();

上面的代码中，我们通过 require 导入 runner-js，然后创建了一个 runner 实例。

添加任务

runner-js 的核心是 Task 类。你可以把一个 JavaScript 函数封装到一个 Task 实例中，然后将这个实例添加到 runner 实例中。

const task = new Task(() => {
  // 这里是你要执行的 JavaScript 代码
});

runner.add(task);

上面的代码中，我们创建了一个 task 实例，并把它添加到 runner 实例中。

如果你需要让这个任务在完成时返回一个结果，可以在 Task 的构造器中传递一个回调函数：

const task2 = new Task((done) => {
  // 这里是你要执行的 JavaScript 代码

  // 执行完毕后，调用 done，并传入结果
  done('这是任务 2 的结果');
});

runner.add(task2);

运行任务

添加完所有任务后，你可以调用 runner 的 run 方法来运行它们：

runner.run().then((results) => {
  console.log(results);
}).catch((error) => {
  console.error(error);
});

上面的代码中，我们调用了 runner 的 run 方法，并使用 then 和 catch 处理运行结果。

任务运行结束后，将返回一个结果数组。如果你的任务中没有返回结果，那么这个数组中的值就是 undefined。

完整示例

下面是一个完整的示例，它包含两个任务，任务 2 在完成时返回一个结果，并打印所有任务的结果数组：

-- -------------------- ---- -------
----- - ------- ---- - - ---------------------

----- ------ - --- ---------

----- ----- - --- ------- -- -
  --------------- - -----
---

----- ----- - --- ----------- -- -
  --------------- - -----

  ------------- -- -
    ---------- - ------
  -- ------
---

------------------
------------------

--------------------------- -- -
  ---------------------
---------------- -- -
  ---------------------
---

总结

本文详细介绍了如何使用 runner-js，在前端和 Node 环境下方便地运行一组 JavaScript 任务。使用 runner-js 可以让你的代码更加简洁和易于维护。如果你需要同时运行多个 JavaScript 任务，并且需要等待它们全部完成后再执行下一步操作，那么 runner-js 是一个非常不错的选择。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005601081e8991b448ddf94