Api Reference

Error Presets

All presets are available via the Errors object.

AppError Class

The base class for all errors. Use this if you need a custom status code.

new AppError(message: string, statusCode: number, isOperational: boolean = true)

Logger

Built-in logger with four levels:

• error - for logging errors
• warning - for logging warnings
• info - for general informational messages
• debug - for detailed debugging information

Use the logError method to log errors:

logError(error: AppError, req?: Request): void

Use the logWarning method to log warnings:

logWarning(message: string, req?: Request): void

Use the logDebug method to log debug information:

logDebug(message: string, req?: Request): void

Use the logInfo method to log general information:

logInfo(message: string): void

Graceful shutdown & Global Handlers:

Configuration

Environment variables that affect library behavior:

• NODE_ENV:
• development: Response includes stack trace.
• production: stack trace, url, method are hidden.
• DEBUG: Set to true to enable debug logs (e.g., viewing raw error details before mapping).

Example Client Response

Development mode:

{
  "status": "error",
  "method": "GET",
  "url": "/api/users/999",
  "message": "User not found",
  "stack": "Error: User not found
    at /app/controllers/user.js:15:20..."
}

Production mode:

{
  "status": "error",
  "message": "User not found"
}

Auto-Mapped Errors:

* Thrown by body-parser when JSON payload is malformed