news 2026/5/15 5:53:54

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/5/7 10:14:58

24、深入探索SharePoint内容类型与Word文档集成

深入探索SharePoint内容类型与Word文档集成 1. Visual Studio 2010中内容类型的操作 在Visual Studio 2010里,对内容类型的操作有多种方式。比如在特定文件中,要对Feature2卸载时移除站点列定义,需取消注释FeatureUninstalling方法并添加相应代码,完整的方法如下: +0 …

作者头像 李华
网站建设 2026/5/11 18:37:21

27、SharePoint工作流开发指南

SharePoint工作流开发指南 1. SharePoint Designer工作流概述 如果你曾进行过SharePoint定制开发,那么对Microsoft SharePoint Designer可能会有所了解。它功能丰富,涵盖从自定义母版页等SharePoint内容到设计工作流等诸多方面。不过,使用SharePoint Designer开发工作流和使…

作者头像 李华
网站建设 2026/5/14 21:49:22

38、SharePoint开发:打包、部署与环境准备全解析

SharePoint开发:打包、部署与环境准备全解析 部署配置验证与冲突处理 要验证新的部署配置,可以将其设置为活动配置并部署项目。其行为与默认配置相同,但在自定义配置中,还会将 .WSP 文件复制到代码中指定的位置。 在开发过程中,通常会反复将同一项目部署到 SharePoin…

作者头像 李华
网站建设 2026/5/14 21:49:43

Excalidraw AI辅助产品经理快速输出原型

Excalidraw&#xff1a;AI 如何重塑产品经理的原型设计方式 在一次跨时区的产品评审会上&#xff0c;一位产品经理仅用三句话描述了一个复杂的用户旅程——“从扫码进入落地页&#xff0c;到填写表单、提交审核&#xff0c;最后收到通知跳转至个人中心”。不到半分钟&#xff0…

作者头像 李华
网站建设 2026/5/13 18:01:44

Excalidraw AI支持法律案件关系图谱构建

Excalidraw AI在法律案件关系图谱构建中的实践与演进 在处理一桩复杂的商业贿赂案时&#xff0c;某律所团队面对上百页的银行流水、数十名关联人员和横跨五年的资金往来记录&#xff0c;传统的Word文档和Excel表格早已不堪重负。一名年轻律师尝试将关键信息手绘成一张人物关系网…

作者头像 李华
网站建设 2026/5/14 3:29:07

还在写代码?用Open-AutoGLM拖拽式设计AI流程,效率提升90%!

第一章&#xff1a;Shell脚本的基本语法和命令Shell脚本是Linux和Unix系统中自动化任务的核心工具&#xff0c;它允许用户通过编写一系列命令来执行复杂的操作。掌握其基本语法和常用命令是系统管理与运维开发的基础。脚本的声明与执行 每个Shell脚本通常以“shebang”开头&…

作者头像 李华