RezoError

RezoError provides structured error information including error codes, HTTP status details, boolean classification flags, and recovery suggestions. All Rezo operations throw RezoError instances on failure.

Constructor

new RezoError<T = any>(
  message: string,
  config: RezoConfig,
  code?: RezoErrorCodeString,
  request?: RezoHttpRequest,
  response?: RezoResponse<T>
)

Example

import { RezoError, RezoErrorCode } from 'rezo';

try {
  await rezo.get('https://unreachable.example.com');
} catch (err) {
  if (err instanceof RezoError) {
    console.log(err.code);       // "ECONNREFUSED"
    console.log(err.message);    // "Connection Refused"
    console.log(err.suggestion); // "Verify the server is running..."
  }
}

Properties

Core Properties

HTTP Properties

Available when the error was created from an HTTP response.

Network Properties

Available for network-level errors.

suggestion

A recovery suggestion string from the ERROR_INFO database.

readonly suggestion: string

catch (err) {
  if (err instanceof RezoError) {
    console.log(err.suggestion);
    // "Verify the server is running and accessible. Check firewall rules..."
  }
}

Boolean Flags

All boolean flags are non-enumerable (accessible but hidden from console.log output). Use them for branching error handling logic.

Example

try {
  await rezo.get('https://api.example.com/resource');
} catch (err) {
  if (!(err instanceof RezoError)) throw err;

  if (err.isTimeout) {
    console.log('Request timed out, retrying...');
  } else if (err.isHttpError && err.status === 429) {
    console.log('Rate limited, backing off...');
  } else if (err.isNetworkError) {
    console.log('Network issue:', err.code);
  } else if (err.isTlsError) {
    console.log('TLS problem:', err.message);
  } else if (err.isProxyError || err.isSocksError) {
    console.log('Proxy failed:', err.code);
  }

  if (err.isRetryable) {
    // Safe to retry this request
  }
}

Instance Methods

toJSON()

Serializes the error to a plain object. Only includes defined values.

toJSON(): Record<string, unknown>

Returns an object with: name, message, code, method, url, finalUrl, status, statusText, urls, cause.

toString()

Returns a formatted error string.

toString(): string

console.log(err.toString());
// "RezoError: Connection Refused [ECONNREFUSED]"

getFullDetails()

Returns a multi-line detailed error report.

getFullDetails(): string

console.log(err.getFullDetails());
// RezoError: Request failed with status code 404
// Code: REZ_HTTP_ERROR
// Method: GET
// URL: https://api.example.com/missing
// HTTP Status: 404 Not Found
//
// Suggestion: Check the status code and response body for more details about the error.

Static Methods

RezoError.isRezoError(error)

Type guard that checks if an unknown value is a RezoError instance. Works across module boundaries via duck-typing.

static isRezoError(error: unknown): error is RezoError

Example

try {
  await rezo.get('/api');
} catch (err) {
  if (RezoError.isRezoError(err)) {
    console.log(err.code); // TypeScript knows this is RezoError
  }
}

RezoError.fromError(error, config, request?, response?)

Wraps a native Error into a RezoError, preserving code, syscall, hostname, port, and address from the original.

static fromError<T = any>(error: Error, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>

Factory Methods

Each factory creates a RezoError with the appropriate error code pre-set.

static createHttpError<T>(statusCode: number, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>
static createNetworkError<T>(message: string, code: RezoErrorCodeString, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createTimeoutError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createAbortError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createParsingError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createEnvironmentError<T>(message: string, config: RezoConfig): RezoError<T>
static createDecompressionError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>
static createDownloadError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>
static createUploadError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>
static createStreamError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>
static createRedirectError<T>(message: string, config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>
static createProxyError<T>(code: RezoErrorCodeString, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createSocksError<T>(code: RezoErrorCodeString, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createTlsError<T>(code: RezoErrorCodeString, config: RezoConfig, request?: RezoHttpRequest): RezoError<T>
static createRateLimitError<T>(config: RezoConfig, request?: RezoHttpRequest, response?: RezoResponse<T>): RezoError<T>

RezoErrorCode Enum

The RezoErrorCode enum provides named constants for all error codes. Use it for readable comparisons.

Network / OS

HTTP

Streams / Transfer

Parsing / Validation

Proxy

SOCKS

TLS / SSL

Example

import { RezoErrorCode } from 'rezo';

try {
  await rezo.get('/api');
} catch (err) {
  if (err.code === RezoErrorCode.CONNECTION_REFUSED) {
    console.log('Server is down');
  } else if (err.code === RezoErrorCode.RATE_LIMITED) {
    console.log('Slow down');
  }
}