JSPM

Install

npm install @visulima/error

yarn add @visulima/error

pnpm add @visulima/error

Usage

Extend the VisulimaError

import { VisulimaError } from "@visulima/error";

class MyError extends VisulimaError {
    constructor(message: string) {
        super({
            name: "MyError",
            message,
        });
    }
}

throw new MyError("My error message");

// or

const error = new MyError("My error message");

error.hint = "My error hint";

throw error;

Get all causes in a error

import { getErrorCauses } from "@visulima/error";

const error = new Error("My error message");
const error2 = new Error("Nested Error");

error.cause = error2;

// The getErrorCauses function will return an array of all causes in the error in the order they occurred.
const causes = getErrorCauses(error);

console.log(causes);

// [
//     {
//         message: "My error message",
//         name: "Error",
//         stack: "Error: My error message\n    at Object.<anonymous> (/visulima/packages/error/src/index.ts:2:16)",
//     },
//     {
//         message: "Nested Error",
//         name: "Error",
//         stack: "Error: Nested Error\n    at Object.<anonymous> (/visulima/packages/error/src/index.ts:3:16)",
//     },
// ];

Pretty Code Frame

Display a pretty code frame with the error location.

Note: Tabs can be used in the source code, codeFrame transforms them to spaces based on the tabWidth option. The default tabWidth is 4, to disable the transformation, set tabWidth to false.

import { codeFrame } from "@visulima/error";

const source = "const x = 10;\nconst error = x.y;\n";
const loc = { column: 16, line: 2 };

const frame = codeFrame(source, { start: loc });

console.log(frame);
//   1 | const x = 10;
// > 2 | const error = x.y;
//     |                ^

API

source

Type: string

The source code to frame.

location

Type: object

The location of the error.

location.start

Type: object

The location of the start of the frame.

location.start.line

Type: number

The line number of the error.

location.start.column

Type: number

The column number of the error.

location.end

Type: object

The location of the end of the frame.

location.end.line

Type: number

The line number of the error.

location.end.column

Type: number

The column number of the error.

options

Type: object

options.linesAbove

Type: number

Default: 2

The number of lines to show above the error.

options.linesBelow

Type: number

Default: 3

The number of lines to show below the error.

options.tabWidth

Type: number | false

Default: 4

Stacktrace

Browser older than 6 years are not supported.

Currently supported browsers/platforms:

• Firefox
• Chrome
• Webkit / Safari
• Edge
• Node / Node V8
• Opera (Chromium based)

import { parseStack } from "@visulima/error";

const error = new Error("My error message");

const stack = parseStack(error);

console.log(stack);

// [
//     {
//         column: 16,
//         file: "file:///Users/danielbannert/Projects/visulima/packages/error/src/index.ts",
//         line: 2,
//         methodName: "Object.<anonymous>",
//         raw: "    at Object.<anonymous> (/visulima/packages/error/src/index.ts:2:16)",
//         type: undefined, // optional property, can be undefined, "eval", "native", or "internal"
//         evalOrigin: undefined, // optional property only available if the stacktrace contains eval
//     },
//     ...and so on
// ];

serialize an error object

• Ensures errors are safe to serialize with JSON
• Can be used as error.toJSON()
• Deep serialization, including transforming
• Custom serialization (e.g. YAML or process.send())
• Keeps both native (TypeError, etc.) and custom error classes
• Preserves errors' additional properties
• Can keep constructor's arguments
• Works recursively with error.cause and AggregateError
• Buffer properties are replaced with [object Buffer]
• Circular references are handled.
• If the input object has a .toJSON() method, then it's called instead of serializing the object's properties.
• It's up to .toJSON() implementation to handle circular references and enumerability of the properties.

import { serializeError } from "@visulima/error";

const error = new TypeError("example");
const errorObject = serializeError(error);
// Plain object: { name: 'TypeError', message: 'example', stack: '...' }

const errorString = JSON.stringify(errorObject);
const newErrorObject = JSON.parse(errorString);

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

About

Related Projects

• baseerr: merge another error with additional properties.
• callsite-record: create a fancy log entries for errors and function call sites.
• callsites: get callsites from the V8 stack trace API.
• explain-error: wrap an error with additional explanation.
• error-wrapper: merges the stack of another error to its own.
• errwischt/stacktrace-parser
• trace: create super long stack traces.
• clarify: remove node related stack trace noise.
• piotr-szewczyk/stacktrace-parser-node
• pretty-error: make the call stacks clear.
• ono: allow different types of error to be thrown.
• ololog: another logger with a similar motivation but only support console.log as its sole transport.
• stacktracejs/error-stack-parser
• marvinhagemeister/errorstacks Tiny library to parse error stack traces
• getsentry/sentry-javascript

License

The visulima error is open-sourced software licensed under the MIT