microsoft / microsoft/azure-devops-node-api
Return types do not indicate nullability
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 502
- Forks
- 244
- Merge moyen
- 2 h 24 min
- PR mergées (30 j)
- 2
Description
Many methods can return null, but the API surface does not reflect this.
For example, GitApi.getRepositories(project) returns null if the project doesn't exist, but the return type is misleadingly listed as Promise<GitRepository[]>.
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
Commencez par localiser GitApi.getRepositories(project) et par suivre la manière dont son type de retour est déclaré et documenté. Examinez les autres méthodes de l’API qui peuvent retourner null, puis vérifiez que leurs types de retour publics TypeScript reflètent ce comportement. Le travail est terminé lorsque la surface d’API concernée ne promet plus de résultats non nuls là où null est possible.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- api
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100