WP Kernel API v0.3.0

---

WP Kernel API / core/src / KernelError

Class: KernelError

Base error class for WP Kernel

Example

throw new KernelError('PolicyDenied', {
  message: 'User lacks required capability',
  context: { policyKey: 'things.manage', userId: 123 }
});

Extends

• Error

Extended by

• TransportError
• ServerError
• PolicyDeniedError

Constructors

Constructor

new KernelError(code, options): KernelError;

Create a new KernelError

Parameters

code

ErrorCode

Error code identifying the error type

options

Error options

message?

string

data?

ErrorData

context?

ErrorContext

Returns

KernelError

Overrides

Error.constructor

Properties

code

readonly code: ErrorCode;

Error code - identifies the type of error

---

data?

readonly optional data: ErrorData;

Additional data about the error

---

context?

readonly optional context: ErrorContext;

Context in which the error occurred

Methods

toJSON()

toJSON(): SerializedError;

Serialize error to JSON-safe format

Returns

SerializedError

Serialized error object

---

fromJSON()

static fromJSON(serialized): KernelError;

Create KernelError from serialized format

Parameters

serialized

SerializedError

Serialized error object

Returns

KernelError

New KernelError instance

---

isKernelError()

static isKernelError(error): error is KernelError;

Check if an error is a KernelError

Parameters

error

unknown

Error to check

Returns

error is KernelError

True if error is a KernelError

---

wrap()

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

Wrap a native Error into a KernelError

Parameters

error

Error

Native error to wrap

code

ErrorCode = 'UnknownError'

Error code to assign

context?

ErrorContext

Additional context

Returns

KernelError

New KernelError wrapping the original