@visulima/error

Visulima error

Error with more than just a message, stacktrace parsing and sourcemap loading.

^{Daniel Bannert's open source work is supported by the community on GitHub Sponsors}

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 { parseStacktrace } from "@visulima/error";

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

const stack = parseStacktrace(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
// ];

API

error

Type: Error

The error to parse.

options

Type: object

options.filter

Type: Function

A function to filter the stack frames.

options.frameLimit

Type: number

The maximum number of frames to parse.

`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);

renderError - pretty print an error

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

const error = new Error("This is an error message");

console.log(renderError(error));

// Error: This is an error message
//
// at <unknown> file:///home/visulima/visulima/examples/error/node/render-error.js:5
//   1 | import { renderError } from "@visulima/error";
//   2 |
//   3 | const error = new Error("This is an error message");
//   4 |
// ❯ 5 | console.log(renderError(new Error("This is an error message")));
//     |                         ^
//   6 |
//
// at ModuleJob.run node:internal/modules/esm/module_job:195
// at async ModuleLoader.import node:internal/modules/esm/loader:336
// at async loadESM node:internal/process/esm_loader:34
// at async handleMainPromise node:internal/modules/run_main:106

colorized output

Use the @visulima/colorize, chalk or some other package to colorize the output.

API

error

Type: AggregateError | Error | VisulimaError
The error to render.

options

Type: object

options.color

Type: object
The color options.