AssertionError
[<AbstractClass>]
type AssertionError =
new (options: AssertionErrorOptions) : AssertionError
[<Literal>] code: string = "ERR_ASSERTION"
member actual: obj with get, set
member code: string with get, set
member expected: obj with get, set
member generatedMessage: bool with get, set
member message: string with get, set
member name: string with get, set
member operator: string with get, set
member stack: string option with get, set
static member stackTraceLimit: float with get, set
static member captureStackTrace (targetObject: obj, ?constructorOpt: Function) : unit
static member prepareStackTrace (err: exn, stackTraces: CallSite array) : obj| Assembly | Xantham.Fable.Node |
| Inherits | exn |
| Attributes | [<Import>] [<AbstractClass>] |
Indicates the failure of an assertion. All errors thrown by the node:assert module will be instances of the AssertionError class.
Constructors
Functions and values
[<Literal>] code: string = "ERR_ASSERTION"
[<Literal>] code: string = "ERR_ASSERTION"Value is always ERR_ASSERTION to show that the error is an assertion error.
TypeScript type: "ERR_ASSERTION"
Properties
member actual: obj with get, set
member actual: obj with get, setSet to the actual argument for methods such as assert.strictEqual().
member code: string with get, set
member code: string with get, setValue is always ERR_ASSERTION to show that the error is an assertion error.
TypeScript type: "ERR_ASSERTION"
member expected: obj with get, set
member expected: obj with get, setSet to the expected argument for methods such as assert.strictEqual().
member generatedMessage: bool with get, set
member generatedMessage: bool with get, setIndicates if the message was auto-generated (true) or not.
static member stackTraceLimit: float with get, set
static member stackTraceLimit: float with get, setThe Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Methods
static member captureStackTrace (targetObject: obj, ?constructorOpt: Function) : unit
static member captureStackTrace (targetObject: obj, ?constructorOpt: Function) : unitCreates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
static member prepareStackTrace (err: exn, stackTraces: CallSite array) : obj
static member prepareStackTrace (err: exn, stackTraces: CallSite array) : obj