什么是 done()，它记录在哪里？

Question

我正在使用 Mocha/Sinon/Chai 了解 JavaScript 中的单元测试。我已经看到使用的函数done()。但我似乎找不到此功能的文档。它似乎不是 JavaScript 语言的一部分。如果是这样，我希望在 [something].prototype.done() 下的 Mozilla 文档中看到它。但它不存在。我没有在 jQuery 的文档中看到它，也没有在 Mocha 的文档中看到它。

On another thread，我看到done()这个例子：

it('should have data.', function () {
    db.put(collection, key, json_payload)
        .then(function (result) {
            result.should.exist;
            done();
        })
        .fail(function (err) {
            err.should.not.exist;
            done();
        })
})

什么是done()，它属于什么语言或工具，它的文档在哪里？ done() 只是回调函数的命名约定吗？

Answer 1

Done 是一个回调，mocha 将作为第一个参数提供给单元测试it block。在测试异步代码时通常需要它，因为可以调用它来通知 mocha it block 已完成。将回调命名为done 是一种很好的做法。但是，您可以根据需要为其命名。 您可以找到它的documentation here，只需在 Windows 上按 ctrl + f 或在 MAC 上按 ⌘ + f，然后输入done。

it('should have data.', function (done) { // inject done here
  db.put(collection, key, json_payload)
    .then(function (result) {
      result.should.exist;
      done();
    })
    .fail(function (err) {
      err.should.not.exist;
      done();
    })
})

从mocha网站复制以下内容。

Testing asynchronous code with Mocha could not be simpler! Simply invoke the callback when your test is complete. By adding a callback (usually named done) to it(), Mocha will know that it should wait for this function to be called to complete the test. This callback accepts both an Error instance (or subclass thereof) or a falsy value; anything else will cause a failed test