microsoft / microsoft/TypeScript
In JSDocs notation for index signatures, Object and object should be treated as the same
オープン
まだ誰も着手していません。
Domain: JSDoc
In Discussion
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
TypeScript Version: 2.7.0-dev.201xxxxx
Code
/**
* Test.
*
* @param {object.<string, number>} obj An object.
*/
function func(obj) {
console.log(obj);
}
Expected behavior:
obj should have a index signature as in #15105
Actual behavior:
obj is treated as any
Additional Info:
This was mentioned in the above issue, and it seems to be related to the way Typescript manage Object and object, but in JSDocs, they are treated similar.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、調査対象の TypeScript バージョンで提供された JSDoc の例を再現し、issue #15105 に記載された動作と比較します。JSDoc のインデックスシグネチャ注釈がどのように解釈されるかを追跡し、その後、object.<string, number> によって obj に any ではなくインデックスシグネチャが与えられることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100