microsoft / microsoft/TypeScript
Can't constrain a generic parameter to have string keys?
还没有人认领这个 Issue。
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 132
描述
Bug Report
Search Terms: Type 'X' cannot be used to index type 'Y', constrain generic parameter to have string keys
- This is the behavior in every version I tried
Code
This type is meant to map another type's values to arrays of {message: V} but also allow {message:unknown} for other string keys.
type Example<M> =
{ [K in keyof M]?: {message: M[K]}[] } &
{ [key in string]: {message: unknown}[] };
For example, the intent is that Example<{ foo: string }> should become
{
foo: {message: string}[];
[key: string]: {message: unknown}[];
}
And this works: we know that "foo" and other strings are valid keys.
const obj: Example<{foo: string}> = {};
obj["foo"] = [{message: "hi"}];
obj["bar"] = [{message: "x"}];
But trying to use Example with a generic parameter gives errors. Even if we don't know M["foo"], we should know that keyof M is string.
// attempt to constrain M's keys to be strings
function test<M extends {[key in string]: unknown}>() {
const obj: Example<M> = {};
obj["foo"] = []; // error: Type '"foo"' cannot be used to index type 'Example<M>'.
obj["bar"] = []; // error: Type '"foo"' cannot be used to index type 'Example<M>'.
}
// should fail, but doesn't -- we've tried to constrain M to have string keys
test<{ 4: string }>();
🙁 Actual behavior
Example<M> cannot be indexed using string when M is a generic parameter.
🙂 Expected behavior
It should always be possible to index with string, since the definition of Example includes { [key in string]: ... }.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从链接的 TypeScript Playground 复现开始,比较具体的 Example<{ foo: string }> 情况和泛型 test<M extends { [key in string]: unknown }>() 情况。调查泛型 indexed access 和键约束的行为;当泛型 Example 支持使用 string 进行索引,而使用数字键的实例化被拒绝时,即完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- compilers
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 35/100