news 2026/8/6 12:15:52

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/8/6 3:30:44

28、SharePoint Web Parts开发指南:从基础到实践

SharePoint Web Parts开发指南:从基础到实践 1. Web Parts简介 Web Parts是一种强大的工具,可用于构建SharePoint网站,使不同的数据或应用程序能够在同一页面上访问。以一个供高管使用的SharePoint内部网站为例,他们可以通过该网站获取不同产品的销售报告、各部门的人员信…

作者头像 李华
网站建设 2026/8/5 19:38:45

33、SharePoint页面创建与开发全解析

SharePoint页面创建与开发全解析 1. 创建站点页面 在创建SharePoint站点页面时,Visual Studio并不提供专门的设计器,不过SharePoint Designer可以发挥作用。以下是使用SharePoint Designer创建站点页面的详细步骤: 1. 打开SharePoint Designer,通过“Open Site”按钮或在…

作者头像 李华
网站建设 2026/8/5 14:06:30

从零理解Open-AutoGLM指令映射机制,掌握GPU利用率翻倍秘诀

第一章&#xff1a;Open-AutoGLM指令集优化概述Open-AutoGLM 是面向大语言模型推理与自动化任务调度的新型指令集架构&#xff0c;旨在提升异构计算环境下的执行效率与资源利用率。该架构通过融合动态指令调度、自适应内存管理与硬件感知编译技术&#xff0c;实现对复杂AI工作流…

作者头像 李华
网站建设 2026/8/5 3:22:08

揭秘Open-AutoGLM可视化引擎:如何3步完成复杂模型部署?

第一章&#xff1a;揭秘Open-AutoGLM可视化引擎的核心价值Open-AutoGLM 是一款面向大模型自动化任务的可视化推理引擎&#xff0c;其核心价值在于将复杂的自然语言处理流程转化为可观察、可调试、可复用的图形化工作流。通过低代码交互界面&#xff0c;开发者与数据科学家能够快…

作者头像 李华
网站建设 2026/8/5 7:32:01

Excalidraw AI训练数据集构建方法论

Excalidraw AI训练数据集构建方法论 在远程协作和敏捷开发日益普及的今天&#xff0c;技术团队对高效、直观的可视化工具需求愈发迫切。Excalidraw 以其独特的手绘风格和极简交互&#xff0c;迅速成为架构图、流程图乃至产品原型设计中的“隐形标准”。但当我们将目光投向AI赋能…

作者头像 李华
网站建设 2026/8/5 8:02:31

Excalidraw图形语义理解模型训练思路

Excalidraw图形语义理解模型训练思路 在一场紧张的架构评审会上&#xff0c;产品经理刚说完“我们需要一个前端调用后端、后端访问数据库的系统图”&#xff0c;工程师已经点开Excalidraw插件&#xff0c;输入一句话&#xff0c;三秒后一张结构清晰的手绘风格架构图就出现在白板…

作者头像 李华