sindresorhus/serialize-error

Add option to decide behavior

Open

#25 创建于 2019年9月23日

在 GitHub 查看
 (5 评论) (2 反应) (0 负责人)JavaScript (599 star) (69 fork)user submission
enhancementhelp wanted

描述

You can throw anything in JS, but it's a bad practice. I'd like to have it fail rather than silently accept anything. Though, it's not a good default, so should be opt-in.

Actually, there's 3 possible behaviors:

  1. Always return an object. (wanted default)
  2. Passthrough non-object values. (current default)
  3. Throw on non-object input.

I'd like 1 to be the default behavior, for consistency, but add an option to be able to opt into 2 (which is the current behavior) or 3 (which would be the strict behavior). This should be a single option.

Another benefit of 1 is that the TypeScript types can be better. We can guarantee it's an object and we can also guarantee that the name, message, and stack properties exist.

贡献者指南

技术栈
javascripttypescriptnodejs
领域
developer experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
Examine the current serialize error implementation in index.js to understand how it handles non object inputs. The issue proposes adding an options parameter with a single option to control behavior: always return object (default), passthrough non object (current), or throw. Look at the TypeScript types file (index.d.ts) to update the function signature to accommodate the new option and ensure the return type reflects the behavior. Review the discussion in the issue for any additional context or edge cases.
Add option to decide behavior · sindresorhus/serialize-error#25 | Good First Issue