microsoft / microsoft/azure-devops-node-api
Return types do not indicate nullability
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 502
- Fork
- 244
- Merge medio
- 2h 24m
- PR unite (30g)
- 2
Descrizione
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[]>.
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
Inizia individuando GitApi.getRepositories(project) e verificando come viene dichiarato e documentato il relativo tipo restituito. Esamina gli altri metodi dell’API che possono restituire null, quindi verifica che i relativi tipi restituiti pubblici di TypeScript riflettano questo comportamento. Il lavoro è completato quando la superficie dell’API interessata non promette più risultati non nulli nei casi in cui null è possibile.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- api
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100