EBSI Problem Details Express middleware

Express middleware that returns properly formmatted Problem Details errors.

Table of Contents

1. Installation
2. Usage
3. Testing
4. Licensing

Installation

npm install @cef-ebsi/express-problem-details

or if you use yarn

yarn add @cef-ebsi/express-problem-details

Usage

In general, you will use this handler in last position, after defining all your Express routes:

import express from "express";
import router from "./router";
import { errorHandler } from "../../src";

const app = express();

// Router
app.use("/", router);

// Error handler
app.use(errorHandler());

Callback

You can pass a callback to the handler. This function will be called before sending the response to the client.

It takes 2 parameters:

• normalizedError, which is the instance of the ProblemDetailsError that is sent to the client.
• originalError, which is the error that was originally passed to the error handler and that is not an instance of ProblemDetailsError. In other words, every error that is thrown by your Express application and that is not an instance of ProblemDetailsError will be passed as originalError to your callback.

Example:

app.use(
  errorHandler((normalizedError, originalError) => {
    if (originalError) console.error(originalError);
    else console.log(normalizedError.toJSON());
  })
);

Testing

Run:

yarn test

Licensing

Copyright (c) 2019 European Commission Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at:

• https://joinup.ec.europa.eu/page/eupl-text-11-12

Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.