Interface: ResourcefulErrorMiddlewareOptions

Configuration options for the ResourcefulErrorMiddleware class. Defines event handlers for different error types and response formatting options.

Example

const options: ResourcefulErrorMiddlewareOptions = {
  onVineValidationError: (error) => logger.warn("Validation failed", error),
  onException: (error) => monitoring.captureException(error),
  onAny: (error) => analytics.trackError(error),
  asYaml: true,
  headers: {
    "X-API-Version": "1.0",
    "Access-Control-Allow-Origin": "*",
  },
};

Properties

Property	Type	Description
asYaml?	boolean	Whether to support YAML response format. Defaults to true
headers?	ResourcefulErrorMiddlewareHeaders	Custom headers to include in all error responses
onAny?	(error: unknown) => void	Event handler called for any error that occurs, regardless of type
onError?	(error: Error) => void	Event handler called when a generic Error is encountered
onException?	(error: Exception) => void	Event handler called when a framework Exception is encountered
onJoiValidationError?	(error: ValidationError) => void	Event handler called when a Joi validation error is encountered
onUnknown?	(error: unknown) => void	Event handler called when an unknown error type is encountered
onVineValidationError?	(error: ValidationError) => void	Event handler called when a Vine validation error is encountered