This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk / EnginexErrorInit

EnginexErrorInit ​

Data to build an EnginexError.

Properties ​

cause? ​

optional cause?: unknown

Original error, when there is one.


code ​

code: EnginexErrorCode

Error code.


details? ​

optional details?: unknown

Raw map sent by the gateway, with the keys as they came (e.g. site_key), not camelCased.


message ​

message: string

Human-readable message (comes from the gateway when there is one).


requestId? ​

optional requestId?: string

Request identifier for support (X-Request-ID).


retryAfter? ​

optional retryAfter?: number

Seconds until it can be retried (Retry-After header).


status ​

status: number

HTTP status; 0 for errors without an HTTP response (network, timeout, cancellation, validation, configuration). Exception: UNAUTHENTICATED thrown by the SDK before sending, without a session, uses 401.