microsoft / microsoft/TypeScript

Declaration merging: remove function overloads?

Ouverte
#19,064 13 commentaires 18 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

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)

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par étudier les exemples de declaration-merging et de module-augmentation dans l’issue, y compris le comportement des surcharges pour express headers et yargs args. Le travail est terminé lorsqu’il existe un moyen pris en charge de supprimer ou de restreindre la surcharge générique d’origine, avec une vérification plus stricte pour le type augmenté.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.