sindresorhus/serialize-error

Add option to decide behavior

Open

#25 opened on 2019年9月23日

GitHub で見る
 (5 comments) (2 reactions) (0 assignees)JavaScript (599 stars) (69 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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