ships.Class.LoadoutEditError

@elite-dangerous-almanac/core / ships / LoadoutEditError

Class: LoadoutEditError

Defined in: src/ships/ship-loadout.ts:203

An editor request that the current hull or build constraints cannot accept.

Remarks

This remains a TypeError, so existing instanceof TypeError handling continues to work. Localized editors should switch on code, then use constraint and params instead of parsing the English fallback in message.

Example

import {
  LoadoutEditError,
  ShipLoadout,
} from '@elite-dangerous-almanac/core/ships/ship-loadout';
import { getModuleBySymbol } from '@elite-dangerous-almanac/core/ships/modules';
import { CORE_MODULES } from '@elite-dangerous-almanac/core/ships/modules-core';

const build = ShipLoadout.empty('SideWinder');
const drive = getModuleBySymbol('Int_Hyperdrive_Size8_Class5', CORE_MODULES)!;
try {
  build.setModule('FrameShiftDrive', drive);
} catch (error) {
  if (error instanceof LoadoutEditError) error.constraint; // -> 'oversized'
}

Extends

• TypeError

Constructors

Constructor

new LoadoutEditError(message, code, params, constraint?): LoadoutEditError

Defined in: src/ships/ship-loadout.ts:219

Construct a structured loadout-edit error.

Parameters

message

string

English fallback suitable for logs.

code

LoadoutEditErrorCode

Stable category for the refused edit.

params

LoadoutIssueParams

Language-neutral values used to render the failure.

constraint?

ModuleFitConstraint

Specific fitting rule, when code is incompatibleModule.

Returns

LoadoutEditError

Overrides

TypeError.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

TypeError.cause

---

code

readonly code: LoadoutEditErrorCode

Defined in: src/ships/ship-loadout.ts:205

Stable category for the refused edit.

---

constraint?

readonly optional constraint?: ModuleFitConstraint

Defined in: src/ships/ship-loadout.ts:207

More specific fitting rule for an incompatibleModule failure.

---

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

TypeError.message

---

name

name: string

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

Inherited from

TypeError.name

---

params

readonly params: LoadoutIssueParams

Defined in: src/ships/ship-loadout.ts:209

Language-neutral values used by the English fallback message.

---

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

TypeError.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.2.0/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

TypeError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.2.0/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

TypeError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@26.2.0/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

TypeError.prepareStackTrace