bcherny/json-schema-to-typescript

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

Open

#604 aberto em 23 de jun. de 2024

Ver no GitHub
 (4 comments) (1 reaction) (0 assignees)TypeScript (449 forks)github user discovery
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (3.302 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Examine o código para ver como as propriedades opcionais são geradas nos tipos TypeScript de saída. Identifique a lógica atual que omite `undefined` das uniões. Projete uma opção para incluir `undefined` quando `exactOptionalPropertyTypes` estiver ativado.
Pilha de tecnologia
typescript
Domain
developer experiencetooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptJSON Schema
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70