@femto-apps/errors/README.md

A simple JavaScript library to handle errors in APIs

### Errors

An opinionated library to help you handle errors in APIs.

#### Usage

An example index file:

```javascript
// require the module
const Errors = require('@femto-host/errors')

// initialise errors
const errors = new Errors('path/to/errors.json')

// add the errors function to your express `res` object.
app.use('/api', (req, res, next) => {
    errors(res)
    next()
})

// register errors.
app.get('/api/test', (req, res) => {
    res.error('ERRNOTFOUND', { file: 'test.txt' })
})
```

An example error file:

```json
{
    "ERRNOTFOUND": {
        "msg": "File {file} was not found.",
        "code": 404
    }
}
```