Typescript - 从使用索引签名定义的对象中获取明确的对象键类型

Question

假设以下对象是使用指定的类型定义创建的。它必须使用索引签名[key: string]，因为允许对象有任何键，甚至根本没有键。

interface CreateObject {
    [key: string]: {
        foo: string
        bar: number
    }
}

const myObject: CreateObject = {
    fooKey: {
        foo: "something",
        bar: 1
    },
    barKey: {
        foo: "something else",
        bar: 2
    }
}

现在，假设我想创建一个接收key 参数的函数。 key 的值应该等于 myObject 中的实际键值，即在上面的示例中，key 应该永远等于 fooKey 或 barKey。

interface SomeFunction {
    (key: keyof typeof myObject): void
}

const someFunction: SomeFunction = (key) => {
    console.log(myObject[key].foo)
}

这不起作用，因为keyof typeof myObject 等于[key: string]，因此只要someFunction(key) 中的key 等于任何字符串，就不会出现任何类型错误。

如何确保只有myObject 中的实际键可以作为key 参数传入？例如：

someFunction("fooKey") // should pass
someFunction("barKey") // should pass
someFunction("notAValidKey"); // should fail

这里有一个 Playground link 来演示这个问题。

Answer 1

不要将对象的类型扩大到带有索引签名的接口。一旦你这样做了，就不可能知道你的对象上有什么键。

如果您仍需要强制执行 myObject 的类型，您可以将其包装在一个身份函数中，该函数会检查其类型而不扩大它。

createObject() 包装器不是绝对必要的，但它使在实例化时生成错误的性质而不是使用对象时更容易识别错误的性质。如果您删除对createObject() 的调用并在myObject 的定义中引入错字，您仍然会收到错误，但它会在调用someFunction() 时发生。

interface CreateObject {
    [key: string]: {
        foo: string
        bar: number
    }
}

function createObject<T extends CreateObject> (object: T) {
    return object
}

const myObject = createObject({
    fooKey: {
        foo: "something",
        bar: 1
    },
    barKey: {
        foo: "something else",
        bar: 2
    }
})

interface SomeFunction {
    <T extends CreateObject> (object: T, key: keyof T): void
}

const someFunction: SomeFunction = (object, key) => {
    console.log(object[key].foo)
}

someFunction(myObject, 'fooKey') // passes
someFunction(myObject, 'barKey') // passes
someFunction(myObject, 'notAValidKey') // fails