https://github.com/hapinessjs/error

Error wrapper based on Boom library to handle and add data in payload response
https://github.com/hapinessjs/error

Last synced: 7 days ago
JSON representation

Error wrapper based on Boom library to handle and add data in payload response

• Host: GitHub
• URL: https://github.com/hapinessjs/error
• Owner: hapinessjs
• License: mit
• Created: 2017-07-12T10:18:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-05-14T11:49:32.000Z (over 5 years ago)
• Last Synced: 2024-11-08T04:39:20.927Z (about 2 months ago)
• Language: TypeScript
• Size: 134 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        






    

        

    

    

        

    

    

        

    

    

        

    





    

        

    

    

        

    

    

        

    





# Biim

Error module based on [boom](https://github.com/hapijs/boom).

## Table of contents

* [Using error module](#using-config-module)

    * [Yarn or NPM it in your package.json](#yarn-or-npm-it-in-your-packagejson)

    * [Use](#use)

* [Change History](#change-history)

* [Maintainers](#maintainers)

* [License](#license)

## Using config module

### `yarn` or `npm` it in your `package.json`

```bash

$ npm install --save @hapiness/biim

or

$ yarn add @hapiness/biim

```

```javascript

"dependencies": {

    "@hapiness/biim": "^1.4.0",

    //...

}

//...

```

### Use

`Node.js Script`:

```javascript

import { Biim } from '@hapiness/biim';

Biim.badRequest('my-message', 'some-data', { key: 'bad-request' });

```

[Back to top](#table-of-contents)

## Change History

* v2.0.0 (2017-05-07)

    * Remove lifecycle

    * Update deps, Boom 7

* v1.4.0 (2017-11-20)

    * Latest packages' versions.

    * Documentation.

    * Change packaging process.

* v1.3.2

    * Add module to have a lifecycle to format error message

    * Latest packages' versions

* v1.2.0

    * Support of `Boom v6.0.0`

    * Latest packages' versions

* v1.1.0

    * Improve error instantiation.

    * Update unit tests.

* v1.0.0

    * Final release version.

* v1.0.0-rc.6 (2017-07-16)

    * Init the project.

[Back to top](#table-of-contents)

## Maintainers

    

        

    

    

        

        

        

        

    

    

        Julien Fauville

        Antoine Gomez

        Sébastien Ritz

        Nicolas Jessel

    

[Back to top](#table-of-contents)

## License

Copyright (c) 2017 **Hapiness** Licensed under the [MIT license](https://github.com/hapinessjs/error/blob/master/LICENSE.md).

[Back to top](#table-of-contents)