microsoft / microsoft/TypeScript
Implicit Symbol.iterator call in for..of loops / spread destructuring doesn't infer `this` generic type parameter
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
TypeScript Version: 4.0.0-dev.20200507
Search Terms: Symbol.iterator type parameter implicit calling for..of loops object spread destructuring this generic
Code
What follows is 3 different ways of iterating over an object using a custom-made iterator. However, using Symbol.iterator implicitly via the for..of loop fails to produce the same behavior:
const obj = {
x: 1,
y: 2,
z: 3,
*[Symbol.iterator]<T extends object>(
this: T,
): Generator<NonNullable<{ [K in keyof T]: [K, NonNullable<T[K]>] }[keyof T]>, void, unknown> {
for (const entry of Object.entries(this)) yield entry as never;
},
};
{
const iter = obj[Symbol.iterator]();
for (let result = iter.next(); !result.done; result = iter.next()) {
const { value } = result;
value; // ["x", number] | ["y", number] | ["z", number]
}
}
for (const value of obj[Symbol.iterator]()) {
value; // ["x", number] | ["y", number] | ["z", number]
}
for (const value of obj) {
value; // NonNullable<{ [K in keyof T]: [K, NonNullable<T[K]>]; }[keyof T]>
// bad! This should be ["x", number] | ["y", number] | ["z", number]
}
// also, spread destructuring suffers from the same problem!
const values = [...obj]; // Array<NonNullable<{ [K in keyof T]: [K, NonNullable<T[K]>]; }[keyof T]>>
// bad! This should be Array<["x", number] | ["y", number] | ["z", number]>
Expected behavior: for (const value of obj) should implicitly do the type equivalent of calling our iterator symbol, i.e. for (const value of obj[Symbol.iterator]()). That means our type parameter should be correctly inferred like so: obj[Symbol.iterator]<T>(this: T).
Actual behavior: T cannot be inferred as the local this type, so all derivative types cannot be evaluated and the type stays as its generic version.
Related Issues: n/a
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
Riproduci il problema usando il codice TypeScript fornito o Playground Link, confrontando le chiamate esplicite a Symbol.iterator con for..of e la destrutturazione con spread. Traccia la gestione da parte del compilatore delle chiamate implicite all'iteratore e dell'inferenza di this generico; il lavoro è completato quando entrambe le forme implicite inferiscono la stessa unione di tuple delle chiamate esplicite.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100