关于vite+vue3+ts项目中env.d.ts 文件详解

server/2025/1/18 0:40:33/

env.d.ts 文件是 Vite 项目中用于定义全局类型声明的 TypeScript 文件。它帮助开发者向 TypeScript提供全局的类型提示,特别是在使用一些特定于 Vite 的功能时(如 import.meta.env)。以下是详细讲解及代码示例

文章目录

      • **1. `env.d.ts` 文件的作用**
      • **2. Vite 环境变量**
      • **3. 创建和配置 `env.d.ts`**
        • **步骤 1:创建 `env.d.ts` 文件**
        • **步骤 2:定义类型声明**
      • **4. 代码示例**
        • **场景:使用环境变量**
      • **5. 声明自定义模块**
        • **代码示例:声明 `.svg` 模块**
      • **6. 注意事项**
      • **7. 总结**


1. env.d.ts 文件的作用

在这里插入图片描述

  • 全局类型声明:用于声明全局类型,例如 import.meta.env 的类型。
  • 模块增强:为一些特殊的模块(如 *.svg*.json 等)提供模块声明。
  • 类型提示支持:帮助 TypeScript 理解 Vite 的环境变量或自定义模块。

2. Vite 环境变量

Vite 中的环境变量通常通过 import.meta.env 获取,如:

console.log(import.meta.env.VITE_API_URL);

为了让 TypeScript 正确识别这些变量,需要在 env.d.ts 中定义相应的类型。


3. 创建和配置 env.d.ts

步骤 1:创建 env.d.ts 文件

在项目的根目录下创建 env.d.ts 文件(通常与 tsconfig.json 同级)。

步骤 2:定义类型声明

以下是 env.d.ts 的一个常见配置:

/// <reference types="vite/client" />interface ImportMetaEnv {readonly VITE_API_URL: string; // 定义一个自定义环境变量readonly VITE_APP_TITLE: string; // 定义另一个变量// 你可以根据需要添加更多变量
}interface ImportMeta {readonly env: ImportMetaEnv;
}

4. 代码示例

场景:使用环境变量
  1. .env 文件内容
VITE_API_URL=https://api.example.com
VITE_APP_TITLE=My Vite App
  1. env.d.ts 文件
/// <reference types="vite/client" />interface ImportMetaEnv {readonly VITE_API_URL: string;readonly VITE_APP_TITLE: string;
}interface ImportMeta {readonly env: ImportMetaEnv;
}
  1. 在项目中使用环境变量
console.log("API URL:", import.meta.env.VITE_API_URL);
console.log("App Title:", import.meta.env.VITE_APP_TITLE);
  1. 启动项目

运行 vite,控制台将输出:

API URL: https://api.example.com
App Title: My Vite App

5. 声明自定义模块

如果项目中使用了非 TypeScript 原生支持的模块(如 .svg.json 文件),需要在 env.d.ts 中声明这些模块的类型。

代码示例:声明 .svg 模块
  1. env.d.ts 中添加声明
declare module "*.svg" {const content: string;export default content;
}
  1. 在代码中使用
import logo from "./assets/logo.svg";console.log("SVG Path:", logo);

6. 注意事项

  1. 不要手动修改生成的 .d.ts 文件:例如 env.d.ts 是用来声明类型的,不用于编写业务逻辑代码。
  2. 命名规范:确保变量名以 VITE_ 开头,这是 Vite 环境变量的要求。
  3. 类型定义准确:尽量为每个变量定义明确的类型(如 stringnumber 等)。

7. 总结

env.d.ts 文件的核心是:

  • 为 Vite 提供环境变量类型提示。
  • 为自定义模块声明类型。
  • 提高 TypeScript 的开发体验。

通过结合 .env 文件、env.d.ts 配置和 TypeScript 的强大能力,可以有效提升 Vite 项目的开发效率和代码质量。


http://www.ppmy.cn/server/159215.html

相关文章

MiniCPM-o 2.6:开源大型语言模型在多模态任务上超越GPT-4o和Claude 3.5

MiniCPM-o 2.6是一款开源的大型语言模型&#xff08;LLM&#xff09;&#xff0c;其在多模态任务上的表现令人瞩目&#xff0c;成功超越了GPT-4o和Claude 3.5等业界知名模型。以下是对MiniCPM-o 2.6的详细介绍&#xff1a; 一、卓越的多模态能力 MiniCPM-o 2.6采用了先进的端…

初学stm32 --- CAN

目录 CAN介绍 CAN总线拓扑图 CAN总线特点 CAN应用场景 CAN物理层 CAN收发器芯片介绍 CAN协议层 数据帧介绍 CAN位时序介绍 数据同步过程 硬件同步 再同步 CAN总线仲裁 STM32 CAN控制器介绍 CAN控制器模式 CAN控制器模式 CAN控制器框图 发送处理 接收处理 接收过…

Pandas库的常用内容归纳

Pandas 是一个强大的 Python 数据分析库&#xff0c;提供了大量用于数据处理和分析的功能。以下是一些 Pandas 库中常用的功能&#xff1a; 数据创建和操作 Series 和 DataFrame&#xff1a;创建一维的 Series 和二维的 DataFrame 对象。数据导入&#xff1a;从 CSV、Excel、…

Google地图瓦片爬虫

地图地址说明 1、谷歌矢量(中文标注) http://mt{0-3}.google.cn/vt/vm416115521&hlzh-CN&glcn&x{x}&y{y}&z{z}&sGalileo 2、谷歌矢量(英文标注) http://mt{0-3}.google.cn/vt/vm416115521&hlen&glcn&x{x}&y{y}&z{z}&sGali…

【MyDB】3-DataManager数据管理 之 0-DataManager数据管理框架

【MyDB】3-DataManager数据管理 之 0.DataManager数据管理框架 DataManagerAbstractCache 引用计数缓存框架DataItemDataManagerPageCacheLogger 日志记录 代码结构参考资料 DataManager 继事务管理后&#xff0c;来到了myDB的核心。数据管理DataManager DataManager 继承了一…

滚动字幕视频怎么制作

在当今的视频创作领域&#xff0c;滚动字幕被广泛应用于各种场景&#xff0c;为视频增添丰富的信息展示和独特的视觉效果。无论是影视剧中的片尾字幕、新闻节目中的资讯滚动&#xff0c;还是综艺节目中的人员与鸣谢信息展示&#xff0c;滚动字幕都发挥着不可或缺的作用。接下来…

Python剪辑视频小妙招(moivepy库)

起因 最近一直在b站上投稿喜羊羊与灰太狼的视频&#xff0c;但是苦于需要手动裁剪视频的片头和片尾&#xff0c;裁剪的多了就发现喜羊羊与灰太狼的视频片头几乎都是1分25秒结束&#xff0c;也就是持续85秒&#xff0c;片尾也差不多是持续1分02秒差不多也就是62秒&#xff0c;于…

effective-Objective-C 第二章阅读笔记

对象&#xff0c;消息&#xff0c;运行期 文章目录 对象&#xff0c;消息&#xff0c;运行期前言理解“属性”这一概念属性修饰符原子性nonatimicatomic 读/写权限内存管理语义方法名 自定义初始化方法小结 在对象内部尽量直接访问实例变量小结 对象等同性特定类的isEqual执行深…