@typia/website
    Preparing search index...

    Interface IProps

    Interface for properties passed to the TypeGuardError constructor.

      const props: TypeGuardError.IProps = {
        method: "typia.assertEquals",
        path: "input.sex",
        expected: "undefined",
        value: 1,
        message: "Custom error message" // optional
      };
    interface IProps {
        description?: string;
        expected: string;
        message?: string;
        method: string;
        path?: string;
        value: unknown;
    }
    Index

    Properties

    description? expected message? method path? value

    Properties

    description?: string

    Optional human-readable description of the type guard error

    This field is rarely populated in standard typia type assertion and is primarily intended for specialized AI agent libraries or custom validation scenarios that require additional context beyond the technical type information. Most assertion errors rely solely on the path, expected, and value fields for comprehensive error reporting.

    expected: string

    String representation of the expected type at the error location.

    string, "number & ExclusiveMinimum<19>";
    message?: string

    Custom error message (optional).

    If not provided, a default format message will be automatically generated.

    method: string

    The name of the typia method that threw the error.

    typia.assert, "typia.assertEquals";
    path?: string

    The access path to the property where the assertion error occurred (optional).

    input.age, "input.profile.email";
    value: unknown

    The actual value that failed assertion.

    Settings

    Member Visibility

    On This Page

    Properties