news 2026/4/23 17:53:08

TypeScript 声明文件

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
TypeScript 声明文件

TypeScript 中的声明文件(Declaration Files)详解

声明文件(Declaration Files)是 TypeScript 的核心机制之一,用于为非 TypeScript 编写的代码(如纯 JavaScript 文件、第三方库、浏览器 API、全局变量等)提供类型信息。声明文件以.d.ts为后缀,只包含类型定义,不包含实现代码,编译后不会生成 JavaScript。

1. 为什么需要声明文件?
  • JavaScript 库(如 jQuery、Lodash)没有类型信息。
  • 浏览器内置 API(如documentwindowfetch)是全局的。
  • 项目中混用.js文件。
  • 第三方 npm 包没有内置类型定义。

使用声明文件后,TypeScript 能在使用这些代码时提供智能提示、类型检查和错误提示

2. 基本语法与结构

声明文件的核心关键字:

  • declare:声明变量、函数、类、模块等存在(不实现)。
  • module/namespace:组织全局或模块声明。
  • interface/type:定义类型。
  • export/import:模块化声明。
3. 常见声明类型
a. 全局变量/函数声明
// globals.d.tsdeclarevarmyGlobalVar:string;// 全局变量declarefunctionmyGlobalFunction(msg:string):void;declareclassGlobalClass{constructor(name:string);say():void;}declareconstBUILD_VERSION:string;// 全局常量

使用:

myGlobalFunction("hello");// 有类型提示
b. 全局命名空间声明(扩展现有对象)
// augmentations.d.tsdeclareglobal{interfaceWindow{myAppConfig:{apiUrl:string;debug:boolean;};}namespaceNodeJS{interfaceProcessEnv{NODE_ENV:"development"|"production";API_KEY:string;}}}// 使用window.myAppConfig.apiUrl;// 有提示process.env.API_KEY;// 类型安全
c. 模块声明(为 JS 模块提供类型)
// declarations/lodash.d.tsdeclaremodule"lodash"{exportfunctionchunk<T>(array:T[],size?:number):T[][];exportfunctiondebounce<TextendsFunction>(func:T,wait:number):T;// ... 其他函数exportdefault_;// 默认导出(如果库是 default)const_:any;}// 使用import_from"lodash";_.chunk([1,2,3,4],2);// 有类型提示
d. 为现有模块添加类型(Module Augmentation)

扩展第三方库(如 express):

// types/express.d.tsimport"express";declaremodule"express-serve-static-core"{interfaceRequest{user?:{id:number;name:string;};}}// 使用 express 时app.use((req,res,next)=>{req.user?.name.toUpperCase();// 有提示,不报错});
4. DefinitelyTyped —— 社区类型定义

最常用的声明文件来源:@types 组织

安装:

npminstall--save-dev @types/lodashnpminstall--save-dev @types/jquerynpminstall--save-dev @types/node# Node.js 全局类型npminstall--save-dev @types/react
  • 超过 10,000+ 个流行库的类型定义。
  • 优先使用@types/xxx,避免自己写。
5. 创建自己的声明文件
示例:为一个 JS 文件提供类型

项目结构:

src/ utils.js // 纯 JavaScript utils.d.ts // 类型声明
// utils.jsmodule.exports={formatDate(date){returndate.toISOString();},capitalize(str){returnstr.charAt(0).toUpperCase()+str.slice(1);}};
// utils.d.tsexportfunctionformatDate(date:Date):string;exportfunctioncapitalize(str:string):string;

使用:

import*asutilsfrom"./utils";utils.capitalize("hello");// 有类型提示
示例:为第三方无类型库写声明
// declarations/my-lib.d.tsdeclaremodule"my-lib"{exportinterfaceOptions{timeout?:number;retries?:number;}exportfunctionrequest(url:string,options?:Options):Promise<string>;exportdefaultrequest;}

放在项目中任意位置,TS 会自动识别。

6. tsconfig.json 中的声明文件配置
{"compilerOptions":{"typeRoots":["./node_modules/@types","./types"],// 自定义类型目录"types":["node","lodash"]// 只加载指定 @types},"include":["src/**/*.ts","src/**/*.d.ts",// 包含自定义声明文件"types/**/*.d.ts"]}
7. 最佳实践建议
建议说明
优先使用@types/xxx社区维护,质量高
自定义声明放types/或项目根便于管理
全局增强用declare global扩展 Window、process 等
模块声明用declare module "xxx"为 JS 库提供类型
避免重复声明利用模块增强而非重写
声明文件不包含实现代码只写类型,编译后消失
开启skipLibCheck: true加速编译(可选)
小结:声明文件类型速查
场景写法示例
全局变量declare var $: any;
扩展 Windowdeclare global { interface Window { app: any; } }
为 JS 模块declare module "my-lib" { export function fn(): void; }
第三方库npm install @types/lodash
Node.js 全局@types/node
模块增强declare module "express" { interface Request { user?: User; } }

声明文件是 TypeScript 与 JavaScript 生态无缝衔接的桥梁。掌握它后,你可以安全地使用任何 JS 库,同时享受完整的类型支持。

如果您想看具体示例(如为 jQuery、Axios、或自定义 JS 项目写声明文件),或者如何发布自己的@types包,请告诉我!

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/23 10:50:19

【大模型工程化突破】:基于Open-AutoGLM的5阶段高效落地框架

第一章&#xff1a;Shell脚本的基本语法和命令Shell 脚本是 Linux 和 Unix 系统中自动化任务的核心工具&#xff0c;通过编写可执行的文本文件&#xff0c;用户能够组合系统命令、控制程序流程并处理数据。一个基本的 Shell 脚本通常以“shebang”开头&#xff0c;用于指定解释…

作者头像 李华
网站建设 2026/4/23 12:10:32

13、Photoshop 样式与滤镜应用全攻略

Photoshop 样式与滤镜应用全攻略 1. 样式面板应用样式 在 Photoshop 中运用样式面板为图层应用样式,能为图像增添丰富效果。以下是具体操作步骤: 1. 打开图层面板 :点击“Layers”标签打开图层面板。若该标签隐藏,可点击“Window”,再选择“Layers”来打开。 2. 显…

作者头像 李华
网站建设 2026/4/22 18:41:36

14、Photoshop 滤镜与形状绘制全攻略

Photoshop 滤镜与形状绘制全攻略 1. 滤镜应用 在图像处理中,滤镜能为图像增添丰富的效果。以下是几种常见滤镜的应用方法: - 添加纹理 1. 选择要应用滤镜的图层。若只想对部分图像应用滤镜,使用选择工具进行选择。 2. 点击“Filter”。 3. 点击“Filter Gallery”,此…

作者头像 李华
网站建设 2026/4/23 12:26:12

26、深入理解 SharePoint 工作流:功能、部署与表单应用

深入理解 SharePoint 工作流:功能、部署与表单应用 1. 工作流完成状态与验证 当 SharePoint 工作流完成时,“共享文档”列表会新增名为 “My First Workflow” 的列,用于显示工作流的当前状态。若一切按预期完成,该列值为 “Completed”;若工作流仍在运行,显示 “In Pr…

作者头像 李华
网站建设 2026/4/23 8:48:13

18、图像编辑与处理技巧全解析

图像编辑与处理技巧全解析 在图像编辑与处理的领域中,有众多的工具和操作技巧可以帮助我们实现各种创意和需求。下面将详细介绍一些常见的操作和相关工具的使用方法。 打印操作步骤 在Mac系统上进行图像打印时,有一系列详细的操作步骤: 1. 准备打印 - 确认要打印的图…

作者头像 李华
网站建设 2026/4/23 8:44:53

中学应有的几何起码常识让2500年都无人能识的“更无理”数一下子浮出水面推翻“R完备、封闭”论

中学应有的几何起码常识让2500年都无人能识的“更无理”数一下子浮出水面推翻“R完备、封闭”论黄小宁初等数学应有几何起码常识&#xff1a;任何图T&#xff08;元点不少于两个&#xff09;的刚体运动都不可使T变为其部分图形。此常识让2500年都无人能识的“更无理”数一下子浮…

作者头像 李华