Skip to main content

Class: LockError

Gala Launchpad SDK 9.0.0-rc.5

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

Class: LockError

Defined in: packages/launchpad-sdk/dist/types/lock.dto.d.ts:215

Lock/Unlock error with detailed information

Extends​

  • Error

Constructors​

Constructor​

new LockError(message, type, details?): LockError

Defined in: packages/launchpad-sdk/dist/types/lock.dto.d.ts:226

Parameters​

message​

string

type​

LockErrorType

details?​
amount?​

string

balance?​

string

lockAuthority?​

string

lockName?​

string

tokenId?​

TokenId

tokenName?​

string

uniqueKey?​

string

Returns​

LockError

Overrides​

Error.constructor

Properties​

details?​

readonly optional details?: object

Defined in: packages/launchpad-sdk/dist/types/lock.dto.d.ts:217

amount?​

optional amount?: string

balance?​

optional balance?: string

lockAuthority?​

optional lockAuthority?: string

lockName?​

optional lockName?: string

tokenId?​

optional tokenId?: TokenId

tokenName?​

optional tokenName?: string

uniqueKey?​

optional uniqueKey?: string

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

type​

readonly type: LockErrorType

Defined in: packages/launchpad-sdk/dist/types/lock.dto.d.ts:216

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