Node.js assert.fail(actual, expected[, message[, operator[, stackStartFn]]])用法及代码示例

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

参数

• actual <any>
• expected <any>
• message <string> | <Error>
• operator <string> 默认： '!='
• stackStartFn <Function> 默认： assert.fail

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

import assert from 'node:assert/strict';

assert.fail('a', 'b');
// AssertionError [ERR_ASSERTION]: 'a' != 'b'

assert.fail(1, 2, undefined, '>');
// AssertionError [ERR_ASSERTION]: 1 > 2

assert.fail(1, 2, 'fail');
// AssertionError [ERR_ASSERTION]: fail

assert.fail(1, 2, 'whoops', '>');
// AssertionError [ERR_ASSERTION]: whoops

assert.fail(1, 2, new TypeError('need array'));
// TypeError: need arrayconst assert = require('node:assert/strict');

assert.fail('a', 'b');
// AssertionError [ERR_ASSERTION]: 'a' != 'b'

assert.fail(1, 2, undefined, '>');
// AssertionError [ERR_ASSERTION]: 1 > 2

assert.fail(1, 2, 'fail');
// AssertionError [ERR_ASSERTION]: fail

assert.fail(1, 2, 'whoops', '>');
// AssertionError [ERR_ASSERTION]: whoops

assert.fail(1, 2, new TypeError('need array'));
// TypeError: need array

在最后三种情况下 actual 、 expected 和 operator 对错误消息没有影响。

使用stackStartFn 截断异常堆栈跟踪的示例：

import assert from 'node:assert/strict';

function suppressFrame() {
  assert.fail('a', 'b', undefined, '!==', suppressFrame);
}
suppressFrame();
// AssertionError [ERR_ASSERTION]: 'a' !== 'b'
//     at repl:1:1
//     at ContextifyScript.Script.runInThisContext (vm.js:44:33)
//     ...const assert = require('node:assert/strict');

function suppressFrame() {
  assert.fail('a', 'b', undefined, '!==', suppressFrame);
}
suppressFrame();
// AssertionError [ERR_ASSERTION]: 'a' !== 'b'
//     at repl:1:1
//     at ContextifyScript.Script.runInThisContext (vm.js:44:33)
//     ...