@wpkernel/core v0.12.1-beta.3

---

@wpkernel/core / EnvironmentalError

Class: EnvironmentalError

Error thrown when environment or readiness preconditions fail.

Extends

• WPKernelError

Constructors

Constructor

new EnvironmentalError(reason, options): EnvironmentalError;

Parameters

reason

string

options

EnvironmentalErrorOptions = {}

Returns

EnvironmentalError

Overrides

WPKernelError.constructor

Properties

code

readonly code: ErrorCode;

Error code - identifies the type of error

Inherited from

WPKernelError.code

---

reason

readonly reason: string;

---

context?

readonly optional context: ErrorContext;

Context in which the error occurred

Inherited from

WPKernelError.context

---

data?

readonly optional data: ErrorData;

Additional data about the error

Inherited from

WPKernelError.data

Methods

fromJSON()

static fromJSON(serialized): WPKernelError;

Create WPKernelError from serialized format

Parameters

serialized

SerializedError

Serialized error object

Returns

WPKernelError

New WPKernelError instance

Inherited from

WPKernelError.fromJSON

---

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

Inherited from

WPKernelError.isWPKernelError

---

toJSON()

toJSON(): SerializedError;

Serialize error to JSON-safe format

Returns

SerializedError

Serialized error object

Inherited from

WPKernelError.toJSON

---

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

Inherited from

WPKernelError.wrap