sindresorhus/serialize-error

Add option to decide behavior

Open

#25 ouverte le 23 sept. 2019

Voir sur GitHub
 (5 commentaires) (2 réactions) (0 assignés)JavaScript (599 stars) (69 forks)user submission
enhancementhelp wanted

Description

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.

Guide contributeur

Stack technique
javascripttypescriptnodejs
Domaine
developer experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.