sdk/errors

Classes

'Read the “', Classes, '” section'

StudioCMS_SDK_Error

'Read the “', StudioCMS_SDK_Error, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:10

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

'Read the “', Extends, '” section'

• StudioCMSError

Extended by

'Read the “', Extended by, '” section'

• StudioCMSCacheError

Constructors

'Read the “', Constructors, '” section'

new StudioCMS_SDK_Error()

'Read the “', new StudioCMS_SDK_Error(), '” section'

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

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/node_modules/astro/dist/core/errors/errors.d.ts:101

Parameters

'Read the “', Parameters, '” section'

message

'Read the “', message, '” section'

string

hint?

'Read the “', hint?, '” section'

string

Returns

'Read the “', Returns, '” section'

StudioCMS_SDK_Error

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.constructor

Properties

'Read the “', Properties, '” section'

cause?

'Read the “', cause?, '” section'

optional cause: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.cause

hint

'Read the “', hint, '” section'

hint: undefined | string;

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/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

'Read the “', Inherited from, '” section'

StudioCMSError.hint

message

'Read the “', message, '” section'

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.message

name

'Read the “', name, '” section'

name: string = 'StudioCMS SDK Error';

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

Overrides

'Read the “', Overrides, '” section'

StudioCMSError.name

stack?

'Read the “', stack?, '” section'

optional stack: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.stack

type

'Read the “', type, '” section'

type: ErrorTypes;

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/node_modules/astro/dist/core/errors/errors.d.ts:95

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.type

prepareStackTrace()?

'Read the “', prepareStackTrace()?, '” section'

static optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:98

Optional override for formatting stack traces

Parameters

'Read the “', Parameters, '” section'

err

'Read the “', err, '” section'

Error

stackTraces

'Read the “', stackTraces, '” section'

CallSite[]

Returns

'Read the “', Returns, '” section'

any

See

'Read the “', See, '” section'

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

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.prepareStackTrace

stackTraceLimit

'Read the “', stackTraceLimit, '” section'

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:100

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.stackTraceLimit

Methods

'Read the “', Methods, '” section'

captureStackTrace()

'Read the “', captureStackTrace(), '” section'

Call Signature

'Read the “', Call Signature, '” section'

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

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:91

Create .stack property on a target object

Parameters

'Read the “', Parameters, '” section'

targetObject

'Read the “', targetObject, '” section'

object

constructorOpt?

'Read the “', constructorOpt?, '” section'

Function

Returns

'Read the “', Returns, '” section'

void

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.captureStackTrace

Call Signature

'Read the “', Call Signature, '” section'

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

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

'Read the “', Parameters, '” section'

targetObject

'Read the “', targetObject, '” section'

object

constructorOpt?

'Read the “', constructorOpt?, '” section'

Function

Returns

'Read the “', Returns, '” section'

void

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.captureStackTrace

is()

'Read the “', is(), '” section'

static is(err: unknown): err is AstroUserError

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/node_modules/astro/dist/core/errors/errors.d.ts:102

Parameters

'Read the “', Parameters, '” section'

err

'Read the “', err, '” section'

unknown

Returns

'Read the “', Returns, '” section'

err is AstroUserError

Inherited from

'Read the “', Inherited from, '” section'

StudioCMSError.is

---

StudioCMSCacheError

'Read the “', StudioCMSCacheError, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:21

Represents an error specific to the StudioCMS cache operations. This class extends the StudioCMS_SDK_Error to provide more context about errors that occur within the caching mechanism of the StudioCMS.

Extends

'Read the “', Extends, '” section'

• StudioCMS_SDK_Error

Constructors

'Read the “', Constructors, '” section'

new StudioCMSCacheError()

'Read the “', new StudioCMSCacheError(), '” section'

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

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/node_modules/astro/dist/core/errors/errors.d.ts:101

Parameters

'Read the “', Parameters, '” section'

message

'Read the “', message, '” section'

string

hint?

'Read the “', hint?, '” section'

string

Returns

'Read the “', Returns, '” section'

StudioCMSCacheError

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.constructor

Properties

'Read the “', Properties, '” section'

cause?

'Read the “', cause?, '” section'

optional cause: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.cause

hint

'Read the “', hint, '” section'

hint: undefined | string;

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/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

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.hint

message

'Read the “', message, '” section'

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.message

name

'Read the “', name, '” section'

name: string = 'StudioCMS Cache Error';

Defined in: studiocms/packages/studiocms/src/sdk/errors.ts:22

Overrides

'Read the “', Overrides, '” section'

StudioCMS_SDK_Error.name

stack?

'Read the “', stack?, '” section'

optional stack: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.stack

type

'Read the “', type, '” section'

type: ErrorTypes;

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/node_modules/astro/dist/core/errors/errors.d.ts:95

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.type

prepareStackTrace()?

'Read the “', prepareStackTrace()?, '” section'

static optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:98

Optional override for formatting stack traces

Parameters

'Read the “', Parameters, '” section'

err

'Read the “', err, '” section'

Error

stackTraces

'Read the “', stackTraces, '” section'

CallSite[]

Returns

'Read the “', Returns, '” section'

any

See

'Read the “', See, '” section'

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

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.prepareStackTrace

stackTraceLimit

'Read the “', stackTraceLimit, '” section'

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:100

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.stackTraceLimit

Methods

'Read the “', Methods, '” section'

captureStackTrace()

'Read the “', captureStackTrace(), '” section'

Call Signature

'Read the “', Call Signature, '” section'

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

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:91

Create .stack property on a target object

Parameters

'Read the “', Parameters, '” section'

targetObject

'Read the “', targetObject, '” section'

object

constructorOpt?

'Read the “', constructorOpt?, '” section'

Function

Returns

'Read the “', Returns, '” section'

void

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.captureStackTrace

Call Signature

'Read the “', Call Signature, '” section'

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

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

'Read the “', Parameters, '” section'

targetObject

'Read the “', targetObject, '” section'

object

constructorOpt?

'Read the “', constructorOpt?, '” section'

Function

Returns

'Read the “', Returns, '” section'

void

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.captureStackTrace

is()

'Read the “', is(), '” section'

static is(err: unknown): err is AstroUserError

Defined in: node_modules/.pnpm/[email protected]_@[email protected]_jiti@[email protected]_typescript@[email protected]/node_modules/astro/dist/core/errors/errors.d.ts:102

Parameters

'Read the “', Parameters, '” section'

err

'Read the “', err, '” section'

unknown

Returns

'Read the “', Returns, '” section'

err is AstroUserError

Inherited from

'Read the “', Inherited from, '” section'

StudioCMS_SDK_Error.is