Vite中自定义类型优先于vite/client默认类型的机制详解

Vite文档建议将自定义类型定义置于vite/client默认类型定义之前，这与TypeScript的类型合并机制密切相关，并非简单的覆盖机制。

TypeScript类型合并策略

TypeScript的类型合并并非简单的后置覆盖，而是根据类型进行合并或优先选择：

• 变量: 变量定义不会合并，第一个定义优先。
• 接口、命名空间、类: 这些会被合并，但前提是现有属性必须类型一致。不一致则会报错。
• 基本类型: 基本类型（如数字、字符串）不会合并，第一个定义优先。

自定义类型优先级的原因

Galileo TypeScript sdk

完整的Galileo AI平台 TypeScript/JS SDK 参考，用于评估、观察和保护 GenAI 应用。适用于构建 Node.js 或 TypeScript 项目。

下载

为了确保自定义类型在合并过程中生效，必须将其置于vite/client默认类型之前。 这是因为接口、命名空间和类的合并机制，允许不同的库或模块为同一个模块提供补充或扩展类型定义。

示例说明

假设模块my-module导出一个名为foo的类，vite/client提供默认类型定义：

<code class="typescript">declare module 'my-module' {
  interface foo {
    bar: number;
  }
}</code>

如果需要为foo类添加属性，则自定义类型定义如下：

<code class="typescript">import 'my-module'; // 必须先引入默认类型

declare module 'my-module' {
  interface foo { // 注意：这里接口名必须与默认类型一致
    baz: string;
  }
}</code>

通过先引入my-module的默认类型定义，再声明自定义扩展，TypeScript会将两个foo接口合并，最终foo类将同时拥有bar和baz属性。如果顺序颠倒，则只会保留自定义类型定义。 因此，正确的顺序确保了自定义类型的有效合并，而不是被覆盖。