Gestión de Errores
When creating a new project with Foal, error handling is already configured for you. When an error is thrown or rejected in a controller or a hook, the application returns an HTML page Internal Server Error
with the status code 500
. If the configuration parameter settings.debug
is set to true
(which is the case during development or testing), the page includes some details about the error (name, message, stack trace, etc).
Customizing the Error Handler
In some situations, we may want to override this behavior. This can be the case when we want, for example, to send the error to an external service, treat some errors in a particular way, customize the error page or return a JSON object to describe the error.
To do this, you can add an handleError
method to the AppController
class.
Reporting Errors
app.controller.ts
import { Context, Get, HttpResponse, IAppController, renderError } from '@foal/core';
export class AppController implements IAppController {
@Get('/')
index() {
throw new Error('Hello world');
}
handleError(error: Error, ctx: Context): HttpResponse|Promise<HttpResponse> {
sendErrorToAnExternalService(error);
return renderError(error, ctx);
}
}