Daniel Bannert's open source work is supported by the community on GitHub Sponsors
npm install @visulima/error
yarn add @visulima/error
pnpm add @visulima/error
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;
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)",
// },
// ];
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;
// | ^
Type: string
The source code to frame.
Type: object
The location of the error.
Type: object
The location of the start of the frame.
Type: number
The line number of the error.
Type: number
The column number of the error.
Type: object
The location of the end of the frame.
Type: number
The line number of the error.
Type: number
The column number of the error.
Type: object
Type: number
Default: 2
The number of lines to show above the error.
Type: number
Default: 3
The number of lines to show below the error.
Type: number
| false
Default: 4
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
// ];
Type: Error
The error to parse.
Type: object
Type: Function
A function to filter the stack frames.
Type: number
The maximum number of frames to parse.
- 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);
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
Use the @visulima/colorize
, chalk
or some other package to colorize the output.
Type: AggregateError | Error | VisulimaError
The error to render.
Type: object
Type: object
The color options.
Type: string
The current working directory.
Type: boolean
Default: false
Display the short path.
Type: number
Default: Number.Infinity
The maximum number of frames to display.
Type: boolean
Default: false
Hide the error cause code view.
Type: boolean
Default: false
Hide the error code view.
Type: boolean
Default: false
Hide the error title.
Type: boolean
Default: false
Hide the error message.
Capture a raw stack trace.
import { captureRawStackTrace } from "@visulima/error";
const stack = captureRawStackTrace();
console.log(stack);
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.
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.
- baseerr: merge another error with additional properties.
- 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.
- node-pretty-exceptions - Pretty and more helpful uncaught exceptions, automatically
- youch-terminal - Display youch error message on terminal
- ono: allow different types of error to be thrown.
- stacktracejs/error-stack-parser
- marvinhagemeister/errorstacks Tiny library to parse error stack traces
- getsentry/sentry-javascript
- serialize-error - Serialize/deserialize an error into a plain object
- baseerr: merge another error with additional properties.
- callsite-record - Create fancy log entries for errors and function call sites
The visulima error is open-sourced software licensed under the MIT