microsoft / microsoft/TypeScript
Docs: "Type assertion" vs "asserts" keyword
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Go
- Estrelas
- 111k
- Forks
- 14.3k
- Merge médio
- 2d 4h
- PRs com merge (30d)
- 132
Descrição
Hey there!
I’m updating Programming TypeScript to include assertions in control flow analysis, and was looking for guidance about naming.
Type assertions (x as T) and assertions in control flow analysis (asserts x is T) are similarly named. What’s a good way to call these these features, in a way that doesn’t confuse people and aligns with the way the TS team is communicating it?
A couple of ideas:
- Rename
x as Tto “type coercion” or “type casting" (even though it’s not a runtime behavior), and callasserts x is Ta “type assertion” - Keep
x as Tas-is (“type assertion”), and callasserts x is Ta “user-defined type assertion”, similar to a “user-defined type guard”
Thanks!
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando o pull request vinculado 32695 e a discussão da issue sobre x as T versus asserts x is T. Considera-se concluído quando se chegar a uma convenção de nomenclatura acordada que esteja alinhada com a comunicação do TypeScript e possa orientar a atualização de Programming TypeScript.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- typescript
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100