bcherny/json-schema-to-typescript

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

Open

#604 geöffnet am 23. Juni 2024

Auf GitHub ansehen
 (4 Kommentare) (1 Reaktion) (0 zugewiesene Personen)TypeScript (449 Forks)github user discovery
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (3.302 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche die Codebasis, wie optionale Eigenschaften in den ausgegebenen TypeScript Typen generiert werden. Identifiziere die aktuelle Logik, die `undefined` aus Unions weglässt. Entwerfe eine Option, um `undefined` einzuschließen, wenn `exactOptionalPropertyTypes` aktiviert ist.
Tech Stack
typescript
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptJSON Schema
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70