@0j3/bench-js 中文文档教程

Question

bench.js

nodejs 中的基准测试工具

Installing

yarn add @0j3/bench-js

Usage

要使用 bench.js，首先要初始化它：

const benchjs = new (require("bench-js"))(true); // The first argument in the constructor of bench.js (the "true") specifies, if benchjs.finish (see below) should output anything

然后，首先创建一个“任务”，您的程序在其中执行您想要进行基准测试的事情（您可以有无限的任务，并且您应该做任何需要大量时间的事情时间有一个任务），通过

const task = benchjs.createTask("Sample Task Name");

在你的代码开头使用。

要启动任务（指定它何时开始执行），请使用

task.begin();

重要提示：不要调用 Task.start，因为它是一个指定何时开始的整数！

要在任务完成时告诉 Bench.JS，请使用

task.finish();

要告诉 Bench.JS 任务出错，请使用

task.error(new Error("Error Message Here"));

在代码末尾，您必须添加

benchjs.finish(0);

0 是可选的，它指定退出代码。

当运行完成时，bench.js 将退出你的程序，一旦它完成输出基准数据，所以在这之后你没有任何其他运行是很重要的。

Bench.JS Sample Output

取自 测试文件

===== BENCHMARK FINISHED =====
Task Node (#0) took 0.10054s
Task App (#1) took 0.02517s
Task Sample Task 1 (#2) took 0.00005s
Task Sample Task 2 (#3) took 0.00005s
Task Sample Task 3 (#4) took 0.00004s
Task Sample Task 4 (#5) DNF | Error (See C:\PATH/TO/BENCHJS/errors/21.9.2020-18.33.5/Sample-Task-4-id-5.err.yml)
Task Sample Task 5 (#6) DNF
Task Finish writing to error files (#7) took 0.0146s
==============================

Extending Bench.JS

如果您想扩展 bench.js，请使用

const BenchOriginal = require("benchjs");
class Bench extends BenchOriginal {
  constructor(outputResults = true) {
    super.constructor(outputResults); // call original constructor
  }
}

并添加您想要的任何内容。

如果您还想扩展任务类，

const BenchOriginal = require("benchjs");
class Task extends BenchOriginal.Task {
  constructor(taskName, id, parent) {
    super.constructor(taskName, id, parent); // call original constructor
  }
}

class Bench extends BenchOriginal {
  constructor(outputResults = true) {
    super.constructor(outputResults); // call original constructor
    super.TaskClass = Task;
  }
}

请从那里使用和添加您想要的任何内容。