microsoft / microsoft/TypeScript
`// @ts-mutate` decorator/directive
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
### 🔍 Search Terms
mutate type, alter type, post-declaration narrow
### ✅ Viability Checklist
- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
### ⭐ Suggestion
When doing property assignment to a variable already typed, allow a `// @ts-mutate` above the assignment which will
- A) Not throw an error trying to assign to a non-existent property
- B) Further narrow the type, encompassing the change
Example:
```ts
interface ObjectType {
bar: string
}
const foo: ObjectType = { bar: 'hello' }
// @ts-mutate
foo.baz = 'hello'
foo
// ^? -- this is now `ObjectType & { baz: string }`
```
### 📃 Motivating Example
One specific example of why this would be useful would be a query constructor for type inference. There are GraphQL query constructors out there ([GenQL](https://genql.dev/)) that query by supplying an object. I've built functions that yield reusable queries but sometimes I want to extend them.
This would allow me to take an existing query object and add an additional field to query, keeping my strict type inference.
### 💻 Use Cases
1. What do you want to use this for?
> This could be used for constructing large objects sequentially and with inference without having to basically duplicate the information
2. What shortcomings exist with current approaches?
> If you have an existing variable, you have to alter its type declaration with the type that it is (explicitly) and intersect it with your changes. This also doesn't necessarily narrow correctly. There's no exisiting clean, easy way to do this that works off of type inference and narrowing
3. What workarounds are you using in the meantime?
> ```ts
> // UGLY
> const query: ReturnType & { prop: { addition?: true } } = queryProp(...args)
> query.prop.addition = true
> ```
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
La issue non identifica i file di implementazione, i test o i punti di ingresso. Inizia esaminando il comportamento proposto di `@ts-mutate` e la sua interazione con il controllo delle assegnazioni e il restringimento dei tipi; il lavoro è completato solo dopo che il design è stato accettato e il comportamento di inferenza richiesto è coperto dai test.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100