microsoft / microsoft/TypeScript
Suggestion: add flag to notify when awaiting a non-promise
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
Search Terms
async promise force error
Suggestion
Add a tsconfig.json flag to display info/warning/error when awaiting non-PromiseLike code. This will catch developer errors.
Use Cases
Catch developer errors when writing async code.
Example
The following code is valid:
await Promise.all(urls.map(url => {
fetch(url);
});
console.log('fetching complete');
The developer intends to do something once all the fetches complete, but since map is not returning any value, it ends up awaiting [undefined, undefined, ...], which means fetching complete is logged before the fetches complete. It would be nice if TS gave an info/warning/error in this case.
The correct code is:
await Promise.all(urls.map(url => {
return fetch(url);
});
console.log('fetching complete');
This example is paired down to the bare minimum for simplicity, but IRL code is more complex.
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Comme aucun fichier source ni test n’est identifié dans l’issue, commencez par localiser la gestion des expressions await par TypeScript et des diagnostics de tsconfig. La tâche est terminée lorsqu’un info, warning ou error configurable pour l’attente de code qui n’est pas PromiseLike est défini et implémenté, avec une couverture pour l’exemple Promise.all fourni.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100