error-editor

Error-Editor is a zero-dependency module that catches errors from functions and promises, allows edits of errors, and throws caught errors again.

Installation

Through NPM:

npm install error-editor

Usage

Require with CommonJS:

const errorEditor = require("error-editor");

Or with ES6 import:

import * as errorEditor from "error-editor";

Documentation

• errorEditor.catchError()
• errorEditor.catchErrorSync()
• class errorEditor.CaughtError
  • CaughtError constructor
  • CaughtError.message
  • CaughtError.constr
  • CaughtError.throw()
• errorEditor.version

errorEditor.catchError(value, ...params) from v1.0.0

Parameters:

• value: Function|Promise|PromiseLike - A function or a promise to catch error from.
• params: any[] - Parameters to pass into value when called (if value is a function). Optional.

Catches an error from value parameter and returns a promise that resolves to it's CaughtError form, if no error occurs, promise resolves to value's return/resolve value.
If the value argument is not a function or a thenable, a TypeError will be thrown.

Note: throw statements that are not called with, and Promise rejects with something else than an Error or its child are considered as Error object with message set to that value.

Usage:

let foo = async (x = "world") => `Hello, ${x}!`;

let value = await errorEditor.catchError(foo);
value; // "Hello, world!"


let bar = (x = "world") => `Hello, ${x}!`;

let value2 = await errorEditor.catchError(foo, "user");
value2; // "Hello, user!"


let baz = Promise.reject("Error appeared!");

let err = await errorEditor.catchError(baz);
err; // CaughtError {constr: Error, message: "Error appeared!"}

errorEditor.catchErrorSync(value, ...params) from v1.0.0

Parameters:

• value: Function - A function to catch error from. Warning: Async functions not supported.
• params: any[] - Parameters to pass into value when called. Optional.

Catches an error from value parameter and returns it's CaughtError form, if no error occurs, returns value's return value. errorEditor.catchError()'s sync version.
If the value argument is not a function, a TypeError will be thrown.
Usage:

let foo = (x = "world") => `Hello, ${x}!`;

let value = errorEditor.catchErrorSync(foo);
value; // "Hello, world!"


let bar = (x = "world") => `Hello, ${x}!`;

let value2 = errorEditor.catchErrorSync(foo, "user");
value2; // "Hello, user!"


let baz = () => {
    throw new Error("Error appeared!");
};

let err = errorEditor.catchErrorSync(baz);
err; // CaughtError {constr: Error, message: "Error appeared!"}

class errorEditor.CaughtError from v1.0.0

class constructor

Parameters:

• message: string|void - Error's message property. Defaults to "" (empty string).
• constr: NewableFunction|void - Error's constructor. Defaults to Error.

If constructing new constr throws an error, the Error constructor will be saved to object.

CaughtError.message from v1.0.0

Error message used to construct the error. Editable.

CaughtError.constr from v1.0.0

Error constructor used to construct the error. Editable.

CaughtError.throw() from v1.0.0

Throws an error based on instance's properties. The message property will be stringified.
If constructing new constr throws an error, the Error constructor will be used.

errorEditor.version from v1.0.0

Contains error-editor package version info. Read-only.