microsoft / microsoft/TypeScript

Declaration merging: remove function overloads?

オープン
#19,064 コメント 13 件 リアクション 18 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

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)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、issue にある declaration-merging と module-augmentation の例を調べます。これには、express headers と yargs args の overload の動作も含まれます。元の generic overload を削除または狭めるためのサポートされた方法があり、augmented type に対してより厳密なチェックが行われれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
compilers
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。