迹忆客 专注技术分享

当前位置:主页 > 学无止境 > 编程语言 > TypeScript >

解决 TypeScript 中 Object literal may only specify known properties 错误

作者:迹忆客 最近更新:2023/01/31 浏览次数:

当对象字面量中的属性在对象类型中不存在时,会发生“Object literal may only specify known properties”错误。 要解决该错误,请确保键入对象的所有属性并修复属性名称中的拼写错误(如果有)。

下面是产生上述错误的一个示例。

type Employee = {
  id: number;
};

// ⛔️ Object literal may only specify known
// properties, and 'name' does not exist in type 'Employee'.
const emp: Employee = { id: 1, name: 'Alice' };

TypeScript 中 Object literal may only specify known properties 错误

Employee 类型只有一个 id 属性,所以当我们尝试将 name 属性分配给 Employee 类型的对象时,会抛出错误。

要解决这个问题,需要确保键入对象文字将具有的所有属性(如果我们提前知道属性名称)。

type Employee = {
  id: number;
  name: string;
};

const emp: Employee = { id: 1, name: 'Alice' };

我们将 name 属性添加到 Employee 类型,因此类型检查器不会再抛出错误。

有时我们无法提前知道对象中所有属性的名称。 在这种情况下,使用索引签名。

type Employee = {
  id: number;
  [key: string]: any;
};

const emp: Employee = { id: 1, name: 'Alice', department: 'accounting' };

{[key: string]: any} 语法称为索引签名,当我们事先不知道对象的所有属性名称和值的形状时使用。

这种语法基本上意味着当使用字符串键索引对象时,它将返回任何类型的值(非常广泛)。

请注意 ,我们仍然可以指定 id 属性,将其设置为数字,因为我们知道所有 Employee 类型的对象都将拥有它。

在使用这种方法时,我们应该始终明确指定我们知道的属性,因为它可以让我们更好地进行类型检查。

如果我们不知道对象的所有属性名称,但知道值的形状,则可以使用更严格的索引签名以获得更好的类型安全性。

type Employee = {
  id: number;
  [key: string]: string | number;
};

const emp: Employee = {
  id: 1,
  name: 'Alice',
  department: 'accounting',
  salary: 100,
};

{[key: string]: string | number} 语法意味着当使用字符串键索引对象时,它将返回一个字符串或数字类型的值。

string | number 语法在 TypeScript 中称为联合类型。

现在我们可以向对象添加任何具有字符串或数字类型值的属性,这比指定任何类型的值在类型安全方面要好得多。

请注意 ,使用此方法时,我们无法添加值类型不是 string | number 的字符串键。

type Employee = {
  id: number;
  [key: string]: string | number;
  // ⛔️ Error: Property 'years' of type 'number[]'
  // is not assignable to 'string' index type 'string | number'.
  years: number[];
};

使用我们的索引签名 [key: string]: string | number,我们告诉 TypeScript,当访问一个字符串键时,它将返回一个字符串或数字的值,所以我们不能添加另一个类型为 number[] 的字符串键。

要解决这个问题,我们必须将 number[] 添加到联合类型。

type Employee = {
  id: number;
  [key: string]: string | number | number[];
  years: number[];
};

const emp: Employee = {
  id: 1,
  name: 'Alice',
  department: 'accounting',
  salary: 100,
  years: [2022, 2023],
};

如果我们不确定对象将包含哪些属性,但通常知道它将是 X 类型之一,请使用联合类型。

class Bird {
  fly() {
    console.log('bird flies');
  }
}

class Fish {
  swim() {
    console.log('fish swims');
  }
}

let obj: Bird | Fish;

// 👇️ (your condition here)
if (Math.random() > 0.5) {
  obj = new Bird();
} else {
  obj = new Fish();
}

console.log(obj); // 👉️ Bird {}

obj 变量存储类型为 BirdFish 的对象。

如果满足条件,我们将一个 Bird 实例分配给该对象,否则我们将一个 Fish 实例分配给该对象。

我们可以将任一值分配给对象,因为我们使用了联合类型。


总结

当对象字面量中的属性在对象类型中不存在时,会发生“Object literal may only specify known properties”错误。 要解决该错误,请确保键入对象的所有属性并修复属性名称中的拼写错误(如果有)。

转载请发邮件至 1244347461@qq.com 进行申请,经作者同意之后,转载请以链接形式注明出处

本文地址:

相关文章

在 TypeScript 中返回一个 Promise

发布时间:2023/03/19 浏览次数:182 分类:TypeScript

本教程讨论如何在 TypeScript 中返回正确的 Promise。这将提供 TypeScript 中 Returns Promise 的完整编码示例,并完整演示每个步骤。

扫一扫阅读全部技术教程

社交账号
  • https://www.github.com/onmpw
  • qq:1244347461

最新推荐

教程更新

热门标签

扫码一下
查看教程更方便