Error Handling

Customizing Error Responses

When it comes to handling errors in your application, customization is key. Here are three ways you can customize error responses in Minimajs

HttpError.toJSON

To customize error responses using the HttpError.toJSON method, you can override the default behavior to return a custom JSON representation of the error. Here's an example:

import { HttpError } from "@minimajs/server/error";

HttpError.toJSON = function (err: HttpError) {
  return { statusCode: err.statusCode, error: err.message };
};

createErrorDecorator

The createErrorDecorator function allows you to customize error responses at the root level or module level of your application. Here's how you can use it:

import { createApp, abort, type App } from "@minimajs/server";
import { HttpError, createErrorDecorator } from "@minimajs/server/error";

export const errorDecorator = createErrorDecorator((err) => {
  if (!HttpError.is(err)) {
    return err; // do not handle if this is not HttpError error
  }
  return new HttpError({ err: err.response, statusCode: err.statusCode }, err.statusCode);
});


const app = createApp();

app.get("/", () => {
  abort("something is not right", 500);
});


// Module-level error handling
app.register(function(app2: App) => {
  app.register(errorDecorator)
  app.get('/something', () => {
    return 'some route'
  })
})


// create or register as many decorators you want,

await app.listen({ port: 1234 });

setErrorHandler

For more fine-grained control over error handling, you can use the setErrorHandler method. This allows you to define a function that will be called whenever an error occurs. Here's an example:

app.setErrorHandler(function (error, request, reply) {
  // Log error
  this.log.error(error);
  // Send error response
  reply.status(409).send({ ok: false });
});

Keep in mind that setErrorHandler will not catch not found (404) errors. For those scenarios, Use app.setNotFoundHandler instead.