sindresorhus/serialize-error

Optionally preserve current stack

Closed

#98 opened on Sep 25, 2024

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)JavaScript (69 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (599 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

An issue I found when throwing deserialized errors is that the thrown error has no reference to this throw point.

I think the "correct" way to throw serialized errors would be something like:

throw new Error(serialized.message, {
	cause: deserializeError(serialized),
});

Two drawbacks:

So how about:

throw deserializeError(serialized, {preserveStack: true});

Contributor guide

Research direction
Implement an optional `preserveStack` parameter in the `deserializeError` function. When set to `true`, the deserialized error should be created with a new stack trace that includes the current call site, while preserving the original error information as the cause.
Tech stack
javascript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75