josdejong/mathjs

TS regression: Narrowing of MathNodes by type

Ouverte

#2 810 ouverte le 13 oct. 2022

Voir sur GitHubGuide contributeur
 (23 commentaires) (0 réaction) (0 personne assignée)JavaScript (1 314 forks)batch import
bughelp wantedtypescript

Métriques du dépôt

Stars
 (15 065 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Describe the bug Prior to v11.3 (not sure how far back, but certainly at least 10), MathNode would be narrowed based on its type property:

const doStuffWithMathNode(node: MathNode) => {
  if (node.type === 'FunctionAssignmentNode) {
    // now TS knows that node is a FunctionAssignmentNode and lets you access associated props
    // like node.params
  }
  // back to being a wider MathNode
}

To Reproduce

Guide contributeur

Direction de recherche
Examinez la régression en étudiant les définitions de type pour MathNode dans le code source de mathjs, en particulier les changements entre v11.2 et v11.3. Utilisez les exemples codesandbox fournis pour comprendre le scénario d'échec. Recherchez les commits récents ayant modifié le rétrécissement de type ou les types MathNode. Passez en revue les fichiers de définition de type du projet (par exemple src/type/) et testez le rétrécissement approprié en utilisant des types conditionnels.
Stack technique
typescript
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70