Skip to main content

Class: ConfigurationError

Gala Launchpad SDK 9.0.0-rc.5

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

Class: ConfigurationError

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

Error thrown when SDK configuration is invalid

This error is used during SDK initialization when configuration parameters are missing, malformed, or incompatible. It helps users identify and fix configuration issues quickly.

Examples​

Invalid configuration

throw new ConfigurationError(
  'Invalid timeout value: must be between 1000 and 300000',
  'timeout'
);

Catching configuration errors

try {
  const sdk = new LaunchpadSDK(config);
} catch (error) {
  if (error instanceof ConfigurationError) {
    console.log(`Fix config field: ${error.field}`);
    console.log(`Issue: ${error.message}`);
  }
}

Extends​

  • Error

Constructors​

Constructor​

new ConfigurationError(message, field?): ConfigurationError

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

Creates a new ConfigurationError

Parameters​

message​

string

Human-readable error message describing the configuration issue

field?​

string

Optional configuration field name that is invalid

Returns​

ConfigurationError

Overrides​

Error.constructor

Properties​

field?​

optional field?: string

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

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