Skip to main content

APIError

satisfactory-dedicated-server-sdk

Defined in: src/exceptions/APIError.ts:18

Base error class for all Satisfactory Dedicated Server API errors.

Encapsulates an errorCode and a descriptive message. All custom API errors (like InvalidParameterError) extend this class to provide consistent error handling.

Example​

try {
  throw new APIError("SERVER_OFFLINE", "The server is not reachable.");
} catch (err) {
  if (err instanceof APIError) {
    console.error(err.toString()); // "SERVER_OFFLINE: The server is not reachable."
  }
}

Extends​

  • Error

Extended by​

Constructors​

Constructor​

new APIError(errorCode, message): APIError

Defined in: src/exceptions/APIError.ts:28

Creates a new APIError.

Parameters​

errorCode​

string

A unique identifier for the error type.

message​

string

A human-readable description of the error.

Returns​

APIError

Overrides​

Error.constructor

Properties​

errorCode​

errorCode: string

Defined in: src/exceptions/APIError.ts:19

message​

message: string

Defined in: src/exceptions/APIError.ts:20

Overrides​

Error.message

name​

name: string

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

Inherited from​

Error.name

stack?​

optional stack: string

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

Inherited from​

Error.stack

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:162

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​

toDict()​

toDict(): object

Defined in: src/exceptions/APIError.ts:48

Converts the error to a dictionary suitable for JSON serialization.

Returns​

object

An object with error_code and message properties.

error_code​

error_code: string

message​

message: string

Example​

const err = new APIError("INVALID_PARAM", "Parameter X is invalid");
console.log(err.toDict());
// Output: { error_code: "INVALID_PARAM", message: "Parameter X is invalid" }

toString()​

toString(): string

Defined in: src/exceptions/APIError.ts:60

Returns a human-readable string representation of the error.

Returns​

string

A string in the format ERROR_CODE: message.

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:146

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/@types/node/globals.d.ts:150

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace