microsoft / microsoft/TypeScript-Website

Somewhat unfortunate example on void return type on a fetching function

Aperta
#3,501 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
2.6k
Fork
1.5k
Merge medio
2g 2h
PR unite (30g)
7

Descrizione

https://github.com/microsoft/TypeScript-Website/blame/0612591abc2d8292c8ddd084b5fb264f203b7026/packages/documentation/copy/en/declaration-files/Do's and Don'ts.md#L81

Sorry if this is overthinking - i am new to typescript.

You are giving a DO example with an interface called "Fetcher" that defines getObject but returning nothing aka void. I think I got the point of "Do write callback parameters as non-optional", but the context is somewhat unfortunate. Maybe there can be thought of a better example for non-optional callback parameters?
Another way to phrase my thought: Is it a DO to use return type void on a getter-Method?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia in packages/documentation/copy/en/declaration-files/Do's and Don'ts.md, nell'esempio collegato intorno alla riga 81. Leggi le indicazioni circostanti sui parametri di callback non opzionali e valuta se l'esempio di Fetcher distingue chiaramente questo punto dalla questione di un tipo di ritorno void. Il lavoro è completato quando l'esempio o la formulazione comunica meglio le indicazioni previste.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.