microsoft / microsoft/azure-devops-node-api
Return types do not indicate nullability
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 502
- Forks
- 244
- Ø Merge
- 2 Std. 24 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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[]>.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, GitApi.getRepositories(project) zu lokalisieren und nachzuverfolgen, wie sein Rückgabetyp deklariert und dokumentiert ist. Überprüfe die anderen API-Methoden, die null zurückgeben können, und stelle anschließend sicher, dass ihre öffentlichen TypeScript-Rückgabetypen dieses Verhalten widerspiegeln. Die Arbeit ist abgeschlossen, wenn die betroffene API-Oberfläche nicht mehr Ergebnisse als nicht null verspricht, wenn null möglich ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100