assert 断言 | Node.js API 文档

assert 断言

assert 断言#

node:assert 模块提供了一组用于验证不变量的断言函数。

严格断言模式#

版本历史

版本	变更
v15.0.0	暴露为 `require('node:assert/strict')`。
v13.9.0, v12.16.2	将“严格模式”更改为“严格断言模式”，将“旧版模式”更改为“旧版断言模式”，以避免与“严格模式”更常见的含义混淆。
v9.9.0	添加错误差异到严格断言模式。
v9.9.0	添加严格断言模式到断言模块。
v9.9.0	新增于: v9.9.0

在严格断言模式下，非严格方法的行为与其对应的严格方法相同。例如，assert.deepEqual() 的行为类似于 assert.deepStrictEqual()。

旧版断言模式#

中英对照

旧版断言模式在以下方法中使用 == 运算符：

assert.AssertionError 类#

中英对照

表示断言的失败。 node:assert 模块抛出的所有错误都是 AssertionError 类的实例。

`new assert.AssertionError(options)`#

中英对照

新增于: v0.1.21

Error 的子类，表示断言的失败。

`assert.CallTracker` 类#

中英对照

新增于: v14.2.0, v12.19.0

此功能目前处于实验阶段，行为可能仍会发生变化。

`new assert.CallTracker()`#

中英对照

新增于: v14.2.0, v12.19.0

创建新的 CallTracker 对象，其可用于跟踪函数是否被调用了特定次数。必须调用 tracker.verify() 才能进行验证。通常的模式是在 process.on('exit') 句柄中调用。

`tracker.calls([fn][, exact])`#

中英对照

新增于: v14.2.0, v12.19.0

预计封装函数将被精确调用 exact 次。如果在调用 tracker.verify() 时函数没有被精确调用 exact 次，那么 tracker.verify() 将抛出错误。

`tracker.report()`#

中英对照

新增于: v14.2.0, v12.19.0

数组包含有关未调用预期次数的函数的预期和实际调用次数的信息。

`tracker.verify()`#

中英对照

新增于: v14.2.0, v12.19.0

遍历传给 tracker.calls() 的函数列表，对于未按预期调用次数的函数将抛出错误。

`assert(value[, message])`#

中英对照

新增于: v0.5.9

assert.ok() 的别名。

`assert.deepEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v18.0.0	现在也比较正则表达式的 lastIndex 属性。
v16.0.0, v14.18.0	在旧版断言模式下，状态从弃用更改为旧版。
v14.0.0	如果双方都是 NaN，则现在 NaN 被视为相同。
v12.0.0	现在可以正确地比较类型标签，并且有一些小的比较调整使检查更少意外。
v9.0.0	现在可以正确地比较 `Error` 名称和消息。
v8.0.0	也比较 `Set` 和 `Map` 的内容。
v6.4.0, v4.7.1	现在可以正确地处理类型化数组切片。
v6.1.0, v4.5.0	现在可以将具有循环引用的对象用作输入。
v5.10.1, v4.4.3	正确地处理非 `Uint8Array` 类型的数组。
v0.1.21	新增于: v0.1.21

严格断言模式

比较详情#

中英对照

以下示例不会抛出 AssertionError，因为使用 == 运算符比较原始值。

`assert.deepStrictEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v18.0.0	现在也比较正则表达式的 lastIndex 属性。
v9.0.0	现在比较可枚举的符号属性。
v9.0.0	现在使用 SameValueZero 比较来比较 `NaN`。
v8.5.0	现在可以正确地比较 `Error` 名称和消息。
v8.0.0	也比较 `Set` 和 `Map` 的内容。
v6.1.0	现在可以将具有循环引用的对象用作输入。
v6.4.0, v4.7.1	现在可以正确地处理类型化数组切片。
v5.10.1, v4.4.3	正确地处理非 `Uint8Array` 类型的数组。
v1.2.0	新增于: v1.2.0

测试 actual 和 expected 参数之间的深度相等。 "深度"相等意味着子对象的可枚举"自有"属性也按照以下规则递归地评估。

比较详情#

中英对照

如果值不相等，则抛出 AssertionError，其 message 属性设置为等于 message 参数的值。如果未定义 message 参数，则分配默认错误消息。如果 message 参数是 Error 的实例，则将抛出错误而不是 AssertionError。

`assert.doesNotMatch(string, regexp[, message])`#

中英对照

版本历史

版本	变更
v16.0.0	此 API 不再是实验的。
v13.6.0, v12.16.0	新增于: v13.6.0, v12.16.0

期望 string 输入与正则表达式不匹配。

`assert.doesNotReject(asyncFn[, error][, message])`#

中英对照

新增于: v10.0.0

等待 asyncFn promise，或者，如果 asyncFn 是函数，则立即调用该函数并等待返回的 promise 完成。然后会检查 promise 是否没有被拒绝。

`assert.doesNotThrow(fn[, error][, message])`#

中英对照

版本历史

版本	变更
v5.11.0, v4.4.5	现在尊重 `message` 参数。
v4.2.0	参数 `error` 现在可以是箭头函数。
v0.1.21	新增于: v0.1.21

断言函数 fn 不会抛出错误。

`assert.equal(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v16.0.0, v14.18.0	在旧版断言模式下，状态从弃用更改为旧版。
v14.0.0	如果双方都是 NaN，则现在 NaN 被视为相同。
v0.1.21	新增于: v0.1.21

严格断言模式

`assert.fail([message])`#

中英对照

新增于: v0.1.21

抛出带有提供的错误消息或默认错误消息的 AssertionError。如果 message 参数是 Error 的实例，则将抛出错误而不是 AssertionError。

`assert.fail(actual, expected[, message[, operator[, stackStartFn]]])`#

中英对照

版本历史

版本	变更
v10.0.0	不推荐使用多个参数调用 `assert.fail()` 并触发警告。
v0.1.21	新增于: v0.1.21

如果 message 为假，则错误消息设置为由提供的 operator 分隔的 actual 和 expected 的值。如果只提供了两个 actual 和 expected 参数，则 operator 将默认为 '!='。如果 message 作为第三个参数提供，则它将用作错误消息，其他参数将作为抛出对象的属性存储。如果提供了 stackStartFn，则该函数之上的所有堆栈帧都将从堆栈跟踪中删除（参见 Error.captureStackTrace）。如果没有给出参数，则将使用默认消息 Failed。

`assert.ifError(value)`#

中英对照

版本历史

版本	变更
v10.0.0	其现在被封装到包含完整堆栈跟踪的 [`AssertionError`][] 中，而不是抛出原始错误。
v10.0.0	值现在可能仅为 `undefined` 或 `null`。之前所有的假值都与 `null` 一样处理并且没有抛出错误。
v0.1.97	新增于: v0.1.97

如果 value 不是 undefined 或 null，则抛出 value。这在回调中测试 error 参数时很有用。堆栈跟踪包含来自传给 ifError() 的错误的所有帧，包括 ifError() 本身的潜在新帧。

`assert.match(string, regexp[, message])`#

中英对照

版本历史

版本	变更
v16.0.0	此 API 不再是实验的。
v13.6.0, v12.16.0	新增于: v13.6.0, v12.16.0

期望 string 输入与正则表达式匹配。

`assert.notDeepEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v16.0.0, v14.18.0	在旧版断言模式下，状态从弃用更改为旧版。
v14.0.0	如果双方都是 NaN，则现在 NaN 被视为相同。
v9.0.0	现在可以正确地比较 `Error` 名称和消息。
v8.0.0	也比较 `Set` 和 `Map` 的内容。
v6.4.0, v4.7.1	现在可以正确地处理类型化数组切片。
v6.1.0, v4.5.0	现在可以将具有循环引用的对象用作输入。
v5.10.1, v4.4.3	正确地处理非 `Uint8Array` 类型的数组。
v0.1.21	新增于: v0.1.21

严格断言模式

`assert.notDeepStrictEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v9.0.0	不再将 `-0` 和 `+0` 视为相等。
v9.0.0	现在使用 SameValueZero 比较来比较 `NaN`。
v9.0.0	现在可以正确地比较 `Error` 名称和消息。
v8.0.0	也比较 `Set` 和 `Map` 的内容。
v6.1.0	现在可以将具有循环引用的对象用作输入。
v6.4.0, v4.7.1	现在可以正确地处理类型化数组切片。
v5.10.1, v4.4.3	正确地处理非 `Uint8Array` 类型的数组。
v1.2.0	新增于: v1.2.0

检验深度严格不相等。 assert.deepStrictEqual() 的相反。

`assert.notEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v16.0.0, v14.18.0	在旧版断言模式下，状态从弃用更改为旧版。
v14.0.0	如果双方都是 NaN，则现在 NaN 被视为相同。
v0.1.21	新增于: v0.1.21

严格断言模式

`assert.notStrictEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v10.0.0	使用的比较从严格相等更改为 `Object.is()`。
v0.1.21	新增于: v0.1.21

测试由 Object.is() 确定的 actual 和 expected 参数之间的严格不相等。

`assert.ok(value[, message])`#

中英对照

版本历史

版本	变更
v10.0.0	无参数的 `assert.ok()` 现在将使用预定义的错误消息。
v0.1.21	新增于: v0.1.21

测试 value 是否为真。相当于 assert.equal(!!value, true, message)。

`assert.rejects(asyncFn[, error][, message])`#

中英对照

新增于: v10.0.0

等待 asyncFn promise，或者，如果 asyncFn 是函数，则立即调用该函数并等待返回的 promise 完成。然后将检查 promise 是否被拒绝。

`assert.strictEqual(actual, expected[, message])`#

中英对照

版本历史

版本	变更
v10.0.0	使用的比较从严格相等更改为 `Object.is()`。
v0.1.21	新增于: v0.1.21

测试由 Object.is() 确定的 actual 和 expected 参数之间的严格相等。

`assert.throws(fn[, error][, message])`#

中英对照

版本历史

版本	变更
v10.2.0	参数 `error` 现在可以是包含正则表达式的对象。
v9.9.0	参数 `error` 现在也可以是对象。
v4.2.0	参数 `error` 现在可以是箭头函数。
v0.1.21	新增于: v0.1.21

期望函数 fn 抛出错误。

assert 断言#

严格断言模式#

旧版断言模式#

assert.AssertionError 类#

new assert.AssertionError(options)#

assert.CallTracker 类#

new assert.CallTracker()#

tracker.calls([fn][, exact])#

tracker.report()#

tracker.verify()#

assert(value[, message])#

assert.deepEqual(actual, expected[, message])#

比较详情#

assert.deepStrictEqual(actual, expected[, message])#

比较详情#

assert.doesNotMatch(string, regexp[, message])#

assert.doesNotReject(asyncFn[, error][, message])#

assert.doesNotThrow(fn[, error][, message])#

assert.equal(actual, expected[, message])#

assert.fail([message])#

assert.fail(actual, expected[, message[, operator[, stackStartFn]]])#

assert.ifError(value)#

assert.match(string, regexp[, message])#

assert.notDeepEqual(actual, expected[, message])#

assert.notDeepStrictEqual(actual, expected[, message])#

assert.notEqual(actual, expected[, message])#

assert.notStrictEqual(actual, expected[, message])#

assert.ok(value[, message])#

assert.rejects(asyncFn[, error][, message])#

assert.strictEqual(actual, expected[, message])#

assert.throws(fn[, error][, message])#

`new assert.AssertionError(options)`#

`assert.CallTracker` 类#

`new assert.CallTracker()`#

`tracker.calls([fn][, exact])`#

`tracker.report()`#

`tracker.verify()`#

`assert(value[, message])`#

`assert.deepEqual(actual, expected[, message])`#

`assert.deepStrictEqual(actual, expected[, message])`#

`assert.doesNotMatch(string, regexp[, message])`#

`assert.doesNotReject(asyncFn[, error][, message])`#

`assert.doesNotThrow(fn[, error][, message])`#

`assert.equal(actual, expected[, message])`#

`assert.fail([message])`#

`assert.fail(actual, expected[, message[, operator[, stackStartFn]]])`#

`assert.ifError(value)`#

`assert.match(string, regexp[, message])`#

`assert.notDeepEqual(actual, expected[, message])`#

`assert.notDeepStrictEqual(actual, expected[, message])`#

`assert.notEqual(actual, expected[, message])`#

`assert.notStrictEqual(actual, expected[, message])`#

`assert.ok(value[, message])`#

`assert.rejects(asyncFn[, error][, message])`#

`assert.strictEqual(actual, expected[, message])`#

`assert.throws(fn[, error][, message])`#