microsoft / microsoft/TypeScript
Narrower (literal) type for Function.prototype.name if function is const
オープン
まだ誰も着手していません。
Awaiting More Feedback
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
Search Terms
ES6 function name, const assertions, as const, function as const
Suggestion
I would like to see the name property of functions to be available at compile time if the given function is a const expression, e.g.:
class Test {
public a() { console.log("Test.a"); }
public b() { console.log("Test.b"); }
}
type FunctionWithName<N> = (...args: any[]) => any & { readonly name: N };
function replaceFunction<T, K extends keyof T>(target: T, fn: FunctionWithName<K>) {
target[fn.name] = fn;
}
// proposed inline syntax
let testInstance = new Test();
replaceFunction(testInstance, function a() { console.log("Replacement.a"); })
// proposed "as const" syntax
const newB = function b() {
console.log("Replacement.b");
} as const;
replaceFunction(testInstance, newB);
// example of a compile time error since "c" is not assignable to "a" | "b"
replaceFunction(testInstance, function c() { console.log("Replacement.a"); })
Use Cases
My use case is a function like shown above, where I would like to have static type checking available, without having to specify the extra parameter that specifies the function name to replace, e.g. compare:
// current syntax:
replaceFunction(testInstance, "a", function a() { /* ... */ });
// proposed syntax:
replaceFunction(testInstance, function a() { /* ... */ });
Examples
let myObject = {
a: () => "a",
b: () => "b"
}
// fictional "mocking" library:
// this syntax can only validate that "a" is in "myObject" through the const "a" parameter
mockingLibrary.mock(myObject, "a", function a() { return "different value" });
// proposed style, using Function.prototype.name
mockingLibrary.mock(myObject, function a() { return "different value" });
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、Function.prototype.name、const expressions、汎用的な replaceFunction 呼び出しに関する提案の例を確認します。型システムと互換性への影響を判断し、そのうえで、リテラルな関数名が保持され、無効な名前が、出力される JavaScript を変更せずに拒否されることを示すテストを定義します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 30/100