OptionalcauseThe cause of the error.
ReadonlyissuesStructured validation issues from the schema library.
ReadonlymethodDotted method path, e.g. "math.divide".
ReadonlyphaseWhether the input arguments or return value failed validation.
OptionalstackStaticstackThe maximum number of stack frames to capture.
StaticcaptureCreate .stack property on a target object
OptionalconstructorOpt: FunctionCreate .stack property on a target object
OptionalconstructorOpt: FunctionOptionalconstructor: FunctionCreates 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();
OptionalconstructorOpt: FunctionStaticisCheck if a value is an instance of Error
The value to check
True if the value is an instance of Error, false otherwise
Check if a value is an instance of Error
The value to check
True if the value is an instance of Error, false otherwise
Staticprepare
Error thrown when RPC validation fails.
Custom properties (
phase,method,issues) survive kkrpc's existingserializeError()/deserializeError()round-trip because that code copies all enumerable properties viafor (const key in error).On the caller side, use
isRPCValidationError()to detect and narrow.