Expected type (for type safety)
Creates a new TypeGuardError instance.
Expected type (for type safety)
Error properties
OptionalcauseOptional ReadonlydescriptionOptional human-readable error description.
Primarily for AI agent libraries or custom validation scenarios needing
additional context. Standard assertions rely on path, expected, and
value for error reporting.
ReadonlyexpectedString representation of expected type.
E.g., "string", "number & ExclusiveMinimum<19>", "{ name: string; age: number }".
ReadonlymethodName of the typia method that threw this error.
E.g., "typia.assert", "typia.assertEquals", "typia.assertGuard".
ReadonlypathProperty path where assertion failed.
Uses dot notation for nested properties. undefined if error occurred at
root level.
E.g., "input.age", "input.profile.email", "input[0].name".
OptionalstackReadonlyvalueActual value that failed assertion.
The raw value at the error path, useful for debugging.
StaticstackThe 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.
StaticcaptureCreates 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: FunctionStaticprepare
Error thrown when type assertion fails.
Thrown by assert, assertGuard, and other assert-family functions when input doesn't match expected type
T. Contains detailed information about the first assertion failure:method: Which typia function threw (e.g.,"typia.assert")path: Property path where error occurred (e.g.,"input.user.age")expected: Expected type string (e.g.,"number & ExclusiveMinimum<19>")value: Actual value that failed validation