在TypeScript中，为具有必需属性的任何对象定义一种类型

harryg 发表于 Dev

哈里格

说我有一个函数，该函数接受某种具有name属性的对象。它不关心对象的其他属性，只关心它name的type是string，因此它应该接受符合此条件的任何对象类型。

是否有定义这种类型的简单方法？我最接近的是扩展使用构造的类型，Record但看起来有点不雅致：

interface ThingWithName extends Record<string, any> {
    name: string
}

function greet(thing: ThingWithName) {
    return `hello, ${thing.name}`
}

greet({name: ''}) // fine
greet({name: '', age: 27}) // also fine

提香·切尔尼科娃·德拉戈米尔

您不需要为此做任何特殊的事情。这将定义所需的属性：

interface ThingWithName {
    name: string
}

function greet(thing: ThingWithName) {
    return `hello, ${thing.name}`
}

greet({name: ''}) // fine
let x = {name: '', age: 27};
greet(x) // also fine

玩

您可能要面对的是多余的属性检查，当对象文字直接分配给特定的类型引用时，该检查会禁止额外的属性。所以在上面的代码中：greet({name: '', age: 27})将是一个错误。

您可以通过以下几种方法之一来解决此限制。

最安全的一种是使用泛型类型参数：

interface ThingWithName {
    name: string
}

function greet<T extends ThingWithName>(thing: T) {
    return `hello, ${thing.name} ${thing.age}` // age is invalid
}

greet({name: ''}) // fine
greet({name: '', age: 27}) // also fine

玩

如果您希望能够使用索引到对象，string那么您发现扩展记录的解决方案是可以的（使用索引签名可以达到相同的效果）：

interface ThingWithName extends Record<string, any> {
    name: string
}

function greet(thing: ThingWithName) {
    return `hello, ${thing.name} ${thing.age}` // age is valid, so be ware you can dot into thing with any prop 
}

greet({name: ''}) // fine
greet({ }) // err
greet({name: '', age: 27}) // also fine

玩

本文收集自互联网，转载请注明来源。

如有侵权，请联系 [email protected] 删除。