Skip to main content

Class: ValidationError

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / ValidationError

Class: ValidationError

Defined in: packages/launchpad-sdk/dist/utils/errors.d.ts:108

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​

Constructors​

Constructor​

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

Defined in: packages/launchpad-sdk/dist/utils/errors.d.ts:118

Creates a new ValidationError

Parameters​

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​

code?​

optional code?: string

Defined in: packages/launchpad-sdk/dist/utils/errors.d.ts:110

field?​

optional field?: string

Defined in: packages/launchpad-sdk/dist/utils/errors.d.ts:109

message​

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from​

Error.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from​

Error.name

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.stack

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.6.5/node_modules/@types/node/globals.d.ts:67

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.

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.6.5/node_modules/@types/node/globals.d.ts:51

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​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@26.6.5/node_modules/@types/node/globals.d.ts:55

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace