@wpkernel/core v0.12.1-beta.3

---

@wpkernel/core / WPKernelError

Class: WPKernelError

Base error class for WPKernel

Example

throw new WPKernelError('CapabilityDenied', {
  message: 'User lacks required capability',
  context: { capabilityKey: 'things.manage', userId: 123 }
});

Extends

• Error

Extended by

• TransportError
• ServerError
• EnvironmentalError

Constructors

Constructor

new WPKernelError(code, options): WPKernelError;

Create a new WPKernelError

Parameters

code

ErrorCode

Error code identifying the error type

options

Error options

context?

ErrorContext

data?

ErrorData

message?

string

Returns

WPKernelError

Overrides

Error.constructor

Properties

code

readonly code: ErrorCode;

Error code - identifies the type of error

---

context?

readonly optional context: ErrorContext;

Context in which the error occurred

---

data?

readonly optional data: ErrorData;

Additional data about the error

Methods

fromJSON()

static fromJSON(serialized): WPKernelError;

Create WPKernelError from serialized format

Parameters

serialized

SerializedError

Serialized error object

Returns

WPKernelError

New WPKernelError instance

---

isWPKernelError()

static isWPKernelError(error): error is WPKernelError;

Check if an error is a WPKernelError

Parameters

error

unknown

Error to check

Returns

error is WPKernelError

True if error is a WPKernelError

---

toJSON()

toJSON(): SerializedError;

Serialize error to JSON-safe format

Returns

SerializedError

Serialized error object

---

wrap()

static wrap(
   error, 
   code, 
   context?): WPKernelError;

Wrap a native Error into a WPKernelError

Parameters

error

Error

Native error to wrap

code

ErrorCode = 'UnknownError'

Error code to assign

context?

ErrorContext

Additional context

Returns

WPKernelError

New WPKernelError wrapping the original