TypeScript中d.ts声明文件怎么编写以及如何为纯JS第三方库补全类型提示

落晨大大_2677

落晨大大_2677

2026-07-23

645人浏览

原创

为纯 javascript 第三方库补全类型提示需编写.d.ts声明文件,核心是用declare module定义模块结构、支持全局声明和类型导出,并注意导出方式、索引签名、泛型及标准类型复用,最后通过definitelytyped或包内types字段发布。

typescript中d.ts声明文件怎么编写以及如何为纯js第三方库补全类型提示

为纯 JavaScript 第三方库补全类型提示,核心是编写一个 .d.ts 声明文件,告诉 TypeScript 这个库的结构、导出内容和类型信息。它不包含运行时代码,只提供类型契约。

声明文件的基本结构与语法

.d.ts 文件本质是类型定义的“说明书”。常见写法有三种:

  • 全局声明:用 declare 直接声明变量、函数或类,适用于挂载在全局(如 window)或通过 <script></script> 引入的库。例如:
      declare const $: (selector: string) => any;
  • 模块声明:用 declare module 'xxx' 包裹整个模块接口,适用于 CommonJS/ESM 模块化引入的库。这是最常用的方式。
  • 类型导出:用 export 或 export default 显式导出类型或值,让其他文件能 import 使用。

为 JS 库手动编写 d.ts 的步骤

以一个无类型提示的轻量库 my-utils 为例(仅导出两个函数:formatDate 和 deepClone):

Add Typescript Best Practices
Add Typescript Best Practices

在 CLAUDE.md 中配置 TypeScript 最佳实践和代码风格规则

下载
  • 创建同名文件 my-utils.d.ts,放在项目 src/@types 或 node_modules/my-utils 下(推荐前者)
  • 使用 declare module 定义模块结构:
    declare module 'my-utils' {
      export function formatDate(date: Date | string, fmt: string): string;
      export function deepClone(obj: T): T;
    }
  • 若库支持 UMD/全局模式,可同时补充全局声明:
    declare global {
      const myUtils: typeof import('my-utils');
    }

提升声明质量的关键细节

好的声明不只是“能用”,还要准确、可维护、兼容多种用法:

  • 区分默认导出与命名导出:检查库实际导出方式(module.exports = xxx vs exports.xxx = ...),决定用 export default 还是 export const xxx
  • 处理动态属性或任意键:对类似 config.xxx 的配置对象,用索引签名:[key: string]: string | number
  • 利用泛型和重载增强提示精度:比如 deepClone 返回值应保留原类型,需泛型参数;多个调用签名可用函数重载模拟
  • 引用已有类型:优先复用 lib.dom.d.ts、lib.es2020.d.ts 中的标准类型(如 Document、Promise),避免重复定义

发布与使用声明文件

本地开发时,只需将 .d.ts 放在 src/@types 目录下,TypeScript 会自动识别。若想共享给社区:

  • 提交到 DefinitelyTyped(主流做法)
  • 或在库自身 package.json 中设置 "types": "index.d.ts",并随包一起发布
  • 使用时无需额外配置,npm install my-utils 后,TypeScript 自动加载类型(前提是声明文件路径正确且未被 exclude)

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

typescript vite js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4446

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1109

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4364

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1776

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3205

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4173

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2680

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习