Documentation
    Preparing search index...

    Properties for constructing a TypeGuardError.

    interface IProps {
        description?: string;
        expected: string;
        message?: string;
        method: string;
        path?: string;
        value: unknown;
    }
    Index

    Properties

    description?: string

    Optional human-readable error description.

    For AI agent libraries or custom validation needing additional context.

    expected: string

    String representation of expected type.

    E.g., "string", "number & ExclusiveMinimum<19>".

    message?: string

    Custom error message (optional).

    If not provided, a default message is generated from other properties.

    method: string

    Name of the typia method that threw the error.

    E.g., "typia.assert", "typia.assertEquals".

    path?: string

    Property path where assertion failed (optional).

    E.g., "input.age", "input.profile.email".

    value: unknown

    Actual value that failed assertion.