function assert.fail
Jump to headingfail(message?: string | Error): neverThrows an AssertionError with the provided error message or a default
error message. If the message parameter is an instance of an Error then
it will be thrown instead of the AssertionError.
import assert from 'node:assert/strict';
assert.fail();
// AssertionError [ERR_ASSERTION]: Failed
assert.fail('boom');
// AssertionError [ERR_ASSERTION]: boom
assert.fail(new TypeError('need array'));
// TypeError: need array
Using assert.fail() with more than two arguments is possible but deprecated.
See below for further details.
Parameters Jump to heading
optional
Jump to headingmessage: string | Error = 'Failed'Return Type Jump to heading
neverJump to headingfail(actual: unknown,expected: unknown,message?: string | Error,operator?: string,stackStartFn?: Function,): neverDeprecated
Parameters Jump to heading
Jump to headingactual: unknownJump to headingexpected: unknownoptional
Jump to headingmessage: string | Erroroptional
Jump to headingoperator: stringoptional
Jump to headingstackStartFn: FunctionReturn Type Jump to heading
never