sdk/errors

Classes

SDKCoreError

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:29^

Represents a core error in the StudioCMS SDK.

This error class is tagged with 'studiocms/sdk/errors/SDKCoreError' and contains additional metadata about the error type and its cause.

Template

The error metadata, including:

• type: The type of error, either 'UNKNOWN' or 'LibSQLDatabaseError'.
• cause: The underlying StudioCMS_SDK_Error that triggered this error.

Remarks

• The toString() method returns a string representation of the error, including the cause’s message.
• The message getter exposes the message from the underlying cause.

Extends

• any

Constructors

Constructor

new SDKCoreError(): SDKCoreError

Returns

SDKCoreError

Inherited from

Data.TaggedError('studiocms/sdk/errors/SDKCoreError')<{
  readonly type: 'UNKNOWN' | 'LibSQLDatabaseError';
  readonly cause: StudioCMS_SDK_Error;
}>.constructor

Accessors

message

Get Signature

get message(): any

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:37^

Returns

any

Methods

toString()

toString(): string

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:33^

Returns

string

---

StudioCMS_SDK_Error

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:11^

Represents an error specific to the StudioCMS SDK. This class extends the StudioCMSError class to provide additional context and functionality for errors occurring within the StudioCMS SDK.

Extends

• StudioCMSError

Constructors

Constructor

new StudioCMS_SDK_Error(message: string, hint?: string): StudioCMS_SDK_Error

Defined in: node_modules/.pnpm/astro@5.12.9_@types+node@24.1.0_jiti@2.4.2_rollup@4.40.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.0/node_modules/astro/dist/core/errors/errors.d.ts:101

Parameters

message

string

hint?

string

Returns

StudioCMS_SDK_Error

Inherited from

StudioCMSError.constructor

Properties

cause?

optional cause: unknown;

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

Inherited from

StudioCMSError.cause

hint

hint: undefined | string;

Defined in: node_modules/.pnpm/astro@5.12.9_@types+node@24.1.0_jiti@2.4.2_rollup@4.40.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.0/node_modules/astro/dist/core/errors/errors.d.ts:99

A message that explains to the user how they can fix the error.

Inherited from

StudioCMSError.hint

message

message: string;

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

Inherited from

StudioCMSError.message

name

name: string = 'StudioCMS SDK Error';

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:12^

Overrides

StudioCMSError.name

stack?

optional stack: string;

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

Inherited from

StudioCMSError.stack

type

type: ErrorTypes;

Defined in: node_modules/.pnpm/astro@5.12.9_@types+node@24.1.0_jiti@2.4.2_rollup@4.40.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.0/node_modules/astro/dist/core/errors/errors.d.ts:95

Inherited from

StudioCMSError.type

stackTraceLimit

static stackTraceLimit: number;

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

StudioCMSError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void

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

StudioCMSError.captureStackTrace

is()

static is(err: unknown): err is AstroUserError

Defined in: node_modules/.pnpm/astro@5.12.9_@types+node@24.1.0_jiti@2.4.2_rollup@4.40.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.0/node_modules/astro/dist/core/errors/errors.d.ts:102

Parameters

err

unknown

Returns

err is AstroUserError

Inherited from

StudioCMSError.is

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any

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

StudioCMSError.prepareStackTrace