Class: ArgsValidationError

An error that contains structured metadata for argument validation failures.

The message remains the English fallback message. Renderers can use code and values to localize the error, falling back to message when localization is unavailable.

Each instance carries a non-enumerable brand keyed by Symbol.for('args-tokens.ArgsValidationError'), which isArgsValidationError uses to recognize instances created by another bundled copy of args-tokens.

Extends

• Error

Signature

export declare class ArgsValidationError extends Error

Constructors

Constructor

new ArgsValidationError(message: string, options?: {
    code?: ArgsValidationErrorCode;
    values?: Record<string, unknown>;
    cause?: unknown;
  }): ArgsValidationError;

Create an ArgsValidationError instance.

Parameters

Name	Type	Description
message	string	fallback error message
options	{ code?: ArgsValidationErrorCode; values?: Record<string, unknown>; cause?: unknown }	structured validation metadata (optional)
options.code?	ArgsValidationErrorCode	optional
options.values?	Record<string, unknown>	optional
options.cause?	unknown	optional

Returns

ArgsValidationError

Properties

Name	Type	Description
code (optional, readonly)	ArgsValidationErrorCode | undefined	Machine-readable error code for this validation failure. This code can also be used as an i18n resource key.
values (readonly)	Record<string, unknown>	Interpolation values for code.