索引类型参数的打字稿默认值

Question

考虑一下 Typescript 文档中 Index types section 中的这个 sn-p：

function getProperty<T, K extends keyof T>(o: T, propertyName: K): T[K] {
    return o[propertyName]; // o[propertyName] is of type T[K]
}

这个函数返回o的属性之一，并且相当复杂的类型签名确保类型检查器在编译时评估这个属性是否真的存在，这非常简洁。

对于一个不同但相似的函数，我想给propertyName一个默认值，所以它不必显式传递，即

function getProperty<T, K extends keyof T>(o: T, propertyName: K = "default"): T[K]

但编译器不喜欢这样，并在函数定义处抛出以下错误：

Type '"default"' is not assignable to type 'K'.
'"default"' is assignable to the constraint of type 'K', but 'K' could be instantiated with a different subtype of constraint 'string | number | symbol'.

我知道数字和符号（？）也可以是有效的索引，但不是为什么这会阻止我将字符串指定为 propertyName 的默认值。有人可以解释为什么这是一个问题以及是否可以解决它？

Answer 1

这里有两个可能的问题：

1. T 可能没有 "default" 属性
2. getProperty 可以通过显式提供泛型类型参数来调用
   例如getProperty<Foo, "someProp">(...)，所以"default"不能分配给这个类型

---

一种可能的解决方案是定义overloads：一个没有属性名称（使用默认值），另一个允许提供属性名称：

function getProperty<T extends { "default"?: any }>(o: T): T["default"]
function getProperty<T, K extends keyof T>(o: T, propertyName: K): T[K]
function getProperty(o: any, propertyName = "default") {
    return o[propertyName];
}

Playground