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.