microsoft / microsoft/TypeScript

Declaration merging: remove function overloads?

Aperta
#19,064 13 commenti 18 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Let's say one of the libs come with a function like this:

// library:
declare module 'example' {
    interface Animal { }
    export function sayHello(a: Animal);
}

I want to narrow down the type to just Dog. This is my module augmentation:

// app.ts
declare module 'example' {
    interface Dog extends Animal { }
    export function sayHello(a: Dog);
}

This merges the declarations to two function overloads:

sayHello(a: Dog);
sayHello(a: Animal);

I'd like to remove the generic Animal one to get stricter type checking of my code.

I couldn't find if this has been discussed before but I would find it useful quite often. Some examples would be:

  • express headers (string by default, I'd use union of string literals)
  • yargs args (I'd limit them to args specific to my app)

Guida per i contributori

Apri la guida per i contributori

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 studiando gli esempi di declaration-merging e module-augmentation nell’issue, incluso il comportamento degli overload per express headers e yargs args. Il lavoro è completato quando esiste un modo supportato per rimuovere o restringere l’overload generico originale, con un controllo più rigoroso per il tipo aumentato.

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

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.