news 2026/9/3 6:22:50

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/9/2 13:30:52

31、SharePoint Web Parts 开发全解析

SharePoint Web Parts 开发全解析 1. Silverlight Web Parts 简介 Silverlight Web Parts 能为用户提供更丰富的界面体验。幸运的是,我们无需编写大量自定义代码来创建此类 Web Part,因为微软发布了项目扩展,其中包含 Web Part 模板。该扩展及相关文档可从 MSDN Code Gal…

作者头像 李华
网站建设 2026/9/2 17:42:31

Excalidraw AI功能本地化部署的硬件要求

Excalidraw AI功能本地化部署的硬件要求 在现代技术团队中&#xff0c;一张随手可画的草图往往比千行文档更能传达设计意图。从系统架构讨论到产品原型构思&#xff0c;可视化协作已成为工程师和设计师日常工作的核心环节。Excalidraw 以其手绘风格、轻量化体验和出色的实时协作…

作者头像 李华
网站建设 2026/9/3 0:03:49

39、SharePoint 2010 及相关工具安装与站点创建指南

SharePoint 2010 及相关工具安装与站点创建指南 1. SharePoint 2010 安装概述 SharePoint 2010 的安装分为三个步骤: 1. 预安装:完成一些先决条件和其他配置。 2. 安装 SharePoint 2010 本身。 3. 运行 SharePoint 2010 配置向导。 其中,预安装步骤在服务器和客户端安…

作者头像 李华
网站建设 2026/9/3 2:37:31

(Open-AutoGLM标准化流程首次公开):支撑千万级请求的底层架构设计

第一章&#xff1a;Open-AutoGLM标准化流程首次公开Open-AutoGLM 是新一代开源自动化生成语言模型调优框架&#xff0c;旨在统一模型训练、评估与部署的全流程标准。该框架通过模块化设计&#xff0c;将数据预处理、提示工程优化、模型微调与推理服务解耦&#xff0c;提升开发效…

作者头像 李华
网站建设 2026/9/3 9:10:19

Excalidraw AI模型版本迭代管理机制

Excalidraw AI模型版本迭代管理机制 在AI能力快速融入各类生产力工具的今天&#xff0c;一个看似简单的“用文字生成图表”功能背后&#xff0c;往往隐藏着复杂的系统工程挑战。以开源白板工具 Excalidraw 为例&#xff0c;当它引入大语言模型&#xff08;LLM&#xff09;实现自…

作者头像 李华
网站建设 2026/9/3 8:21:59

告别复杂编程:Open-AutoGLM无代码平台5大隐藏功能首次曝光

第一章&#xff1a;告别复杂编程——Open-AutoGLM无代码平台全景解析在人工智能快速普及的今天&#xff0c;开发者与业务人员之间的技术鸿沟依然显著。Open-AutoGLM应运而生&#xff0c;作为一款领先的无代码AI开发平台&#xff0c;它让非技术人员也能轻松构建、训练并部署自然…

作者头像 李华