https://github.com/suddi/project-error

Customized error class module for projects/microservices. Throw error objects within a JavaScript Error class while preserving the stack (https://www.npmjs.com/package/project-error)
https://github.com/suddi/project-error

custom-error error error-formatting error-handling

Last synced: 3 months ago
JSON representation

Customized error class module for projects/microservices. Throw error objects within a JavaScript Error class while preserving the stack (https://www.npmjs.com/package/project-error)

• Host: GitHub
• URL: https://github.com/suddi/project-error
• Owner: suddi
• License: mit
• Created: 2017-12-01T13:50:46.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T18:13:01.000Z (over 2 years ago)
• Last Synced: 2025-02-12T20:05:16.637Z (4 months ago)
• Topics: custom-error, error, error-formatting, error-handling
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/project-error
• Size: 280 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ProjectError

[![CircleCI](https://circleci.com/gh/suddi/project-error.svg?style=svg)](https://circleci.com/gh/suddi/project-error)

[![codecov](https://codecov.io/gh/suddi/project-error/branch/master/graph/badge.svg)](https://codecov.io/gh/suddi/project-error)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f3cbca070bbd4488b579748680348c28)](https://www.codacy.com/app/Suddi/project-error)

[![npm](https://img.shields.io/npm/v/project-error.svg)](https://www.npmjs.com/package/project-error)

[![npm](https://img.shields.io/npm/dt/project-error.svg)](https://www.npmjs.com/package/project-error)

[![David](https://img.shields.io/david/suddi/project-error.svg)](https://david-dm.org/suddi/project-error)

[![David](https://img.shields.io/david/dev/suddi/project-error.svg)](https://david-dm.org/suddi/project-error?type=dev)

[![license](https://img.shields.io/github/license/suddi/project-error.svg)](https://raw.githubusercontent.com/suddi/project-error/master/LICENSE)

[![codecov](https://codecov.io/gh/suddi/project-error/branch/master/graphs/commits.svg)](https://codecov.io/gh/suddi/project-error)

Customized error class module for project/microservices. Throw error enum objects within a JavaScript Error class preserving the stack.

## Installation

````

npm install --save project-error

````

## Usage

1) Pass any object containing into the first argument of `ProjectError`:

````js

var ProjectError = require('project-error');

throw new ProjectError({

    code: 4010,

    statusCode: 400,

    message: 'Bad Request'

});

````

2) Pass additional error details as either a string or an array of strings:

````js

var ProjectError = require('project-error');

var errorObj = {

    code: 4010,

    statusCode: 400,

    message: 'Bad Request'

};

var errorDetail = 'This is a one-liner error detail';

throw new ProjectError(errorObj, errorDetail);

````

````js

var ProjectError = require('project-error');

var errorObj = {

    code: 4010,

    statusCode: 400,

    message: 'Bad Request'

};

var errorDetails = [

    'This is multiple lines of error details',

    'This is multiple lines of error details',

    'This is multiple lines of error details'

];

throw new ProjectError(errorObj, errorDetails);

````

3) Pass a standard `Error` object and preserve the stack:

````js

var errorObj = {

    code: 4010,

    statusCode: 400,

    message: 'Bad Request'

};

var errorDetail = 'This is a one-liner error detail';

var error = new Error('Fail!');

throw new ProjectError(errorObj, errorDetail, error);

````