Skip to content

A better error that is inspired by the Java exception that is also serializable to JSON.

License

Notifications You must be signed in to change notification settings

lsphillips/run-time-error

Repository files navigation

run-time-error

Available from NPM Built using GitHub Action

A better error that is inspired by the Java exception that is also serializable to JSON.

Usage

import { RuntimeError } from 'run-time-error';

try
{
  throw new Error('The root cause error.');
}
catch (cause)
{
  throw new RuntimeError('An unexpected error occurred while performing an operation.', cause);
}

This module can also be treated as a CommonJS module:

const { RuntimeError } = require('run-time-error');

Getting started

This project is available through the Node Package Manager (NPM), so you can install it like so:

npm install run-time-error

Please Note: Versions of Node lower than v12.0.0 are not supported.

Development

Building

You can build UMD and ESM versions of this module that are minified:

npm run build

Testing

This module also has a robust test suite:

npm test

This also runs code quality checks using ESLint. Please refer to the .eslintrc files to familiar yourself with the rules.

License

This project is released under the MIT license.