feng xiaohan

对象的类型(接口)

在 TypeScript 中,我们使用接口(Interface)来定义对象的类型。

用于匹配两个对象是否相等。

interface Person {
  name: string;
  age: number;
}

let tom: Person = {
  name: "Tom",
  age: 25,
};

上面的例子中,我们定义了一个接口 Person,接着定义了一个变量 tom,它的类型是 Person。这样,我们就约束了 tom 的形状必须和接口 Person 一致。

接口一般首字母大写。

赋值的时候,变量的形状必须和接口的形状保持一致

  • 对象的属性要完全和 interface 里定义的相同
  • 如果有同名的 interface,则会自动产生合并

可选属性

有时我们希望不要完全匹配一个形状,那么可以用可选属性(**?**):

interface Person {
  name: string;
  age?: number;
}

let tom: Person = {
  name: "Tom",
};
interface Person {
  name: string;
  age?: number;
}

let tom: Person = {
  name: "Tom",
  age: 25,
};

可选属性的含义是该属性可以不存在但仍然不允许添加未定义的属性

索引签名——定义任意属性(*)

有时候我们希望一个接口允许有任意的属性(不确定还有什么类型的其他值),可以使用如下方式:

interface Person {
  name: string;
  age?: number;
  [propName: string]: any;
}

let tom: Person = {
  name: "Tom",
  gender: "male",
  a: 1,
  b: "456",
};

使用 [propName: string] 定义了任意属性取 string 类型的值。

注意:一旦定义了任意属性(索引签名),那么确定属性和可选属性的类型都必须是它的类型的子集,例:

interface Person {
  name: string;
  age?: number;
  [propName: string]: string; // 其中的类型必须是string或是其子类型,不然就会报错,所以一般写any
}

let tom: Person = {
  name: "Tom",
  age: 25,
  gender: "male",
};

// index.ts(3,5): error TS2411: Property 'age' of type 'number' is not assignable to string index type 'string'.
// index.ts(7,5): error TS2322: Type '{ [x: string]: string | number; name: string; age: number; gender: string; }' is not assignable to type 'Person'.
//   Index signatures are incompatible.
//     Type 'string | number' is not assignable to type 'string'.
//       Type 'number' is not assignable to type 'string'.

一个接口中只能定义一个任意属性。如果接口中有多个类型的属性,则可以在任意属性中使用联合类型:

interface Person {
  name: string;
  age?: number;
  [propName: string]: string | number;
}

let tom: Person = {
  name: "Tom",
  age: 25,
  gender: "male",
};

只读属性

对于可有可无的值,可以使用?来定义

有时候我们希望对象中的一些字段只能在创建的时候被赋值,那么可以用 readonly定义只读属性

被赋予只读的属性,只能被访问,不能被修改。

interface Person {
  readonly id: number; // 只读属性
  name: string;
  age?: number;
  [propName: string]: any;
}

let tom: Person = {
  id: 89757,
  name: "Tom",
  gender: "male",
};

tom.id = 9527;

// index.ts(14,5): error TS2540: Cannot assign to 'id' because it is a constant or a read-only property.

上例中,使用 readonly 定义的属性 id 初始化后,又被赋值了,所以报错了。

注意,只读的约束存在于第一次给对象赋值的时候,而不是第一次给只读属性赋值的时候

interface Person {
  readonly id: number;
  name: string;
  age?: number;
  [propName: string]: any;
}

let tom: Person = {
  name: "Tom",
  gender: "male",
};

tom.id = 89757;

// index.ts(8,5): error TS2322: Type '{ name: string; gender: string; }' is not assignable to type 'Person'.
//   Property 'id' is missing in type '{ name: string; gender: string; }'.
// index.ts(13,5): error TS2540: Cannot assign to 'id' because it is a constant or a read-only property.

上例中,报错信息有两处,第一处是在对 tom 进行赋值的时候,没有给 id 赋值。

第二处是在给 tom.id 赋值的时候,由于它是只读属性,所以报错了。

接口继承——extends

被继承的接口会合并到当前接口里。

interface A extends B {
  name: string;
  age: number;
  readonly id: number;
}

interface B {
  sex: string;
}

let a: A = {
  id: 2,
  name: "张三",
  age: 18,
  sex: "男",
};

函数定义

使用 interface 定义函数类。

interface Fn {
  (name: string): number[];
}
  • ():定义函数传递的参数名称和类型;
  • number[]:定义了函数返回值的类型,此处为 number 类型的数组;
const fn: Fn = function (name: string) {
  return [1];
};