bcherny/json-schema-to-typescript

Option for adding `undefined` to optional union for optional properties.

Open

#604 ouverte le 23 juin 2024

Voir sur GitHub
 (4 commentaires) (1 réaction) (0 assignés)TypeScript (449 forks)github user discovery
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (3 302 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

In TypeScript, when exactOptionalPropertyTypes is set to true, properties that are optional?: but not do not include | undefined in their union can not be assigned a value of undefined.

For generating code that will be consumed by others, we may not want to force them to turn off exactOptionalPropertyTypes. For that please consider an option to include undefined in generated type unions of non-required properties.

Guide contributeur

Direction de recherche
Examinez la base de code pour voir comment les propriétés optionnelles sont générées dans les types TypeScript en sortie. Identifiez la logique actuelle qui omet `undefined` des unions. Concevez une option pour inclure `undefined` lorsque `exactOptionalPropertyTypes` est activé.
Stack technique
typescript
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
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
TypeScriptJSON Schema
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70