index/classes/ValidationError.md

Error thrown when validation fails

This error is used throughout the SDK to indicate that input validation has failed. It provides structured information about what failed and why.

Examples

Basic validation error

throw new ValidationError(
  'Token name must be between 1 and 25 characters',
  'tokenName',
  'INVALID_TOKEN_NAME'
);

Catching validation errors

try {
  validateTokenName(name);
} catch (error) {
  if (error instanceof ValidationError) {
    console.log(`Field: ${error.field}`);
    console.log(`Code: ${error.code}`);
    console.log(`Message: ${error.message}`);
  }
}

Extends

• Error

Extended by

• TokenRestrictedError

Constructors

Constructor

new ValidationError(message, field?, code?): ValidationError

Creates a new ValidationError

Parameters

Parameter	Type	Description
message	string	Human-readable error message describing what failed
field?	string	Optional field name that failed validation
code?	string	Optional error code for programmatic handling (e.g., 'INVALID_TOKEN_NAME')

Returns

ValidationError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
code?	public	string	-	-
field?	public	string	-	-
message	public	string	-	Error.message
name	public	string	-	Error.name
stack?	public	string	-	Error.stack
stackTraceLimit	static	number	The 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.	Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Creates 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();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace