TypeScript中模块声明declaremodule怎么为没有提供类型的纯JS npm包手动编写补全

轻雪同学_7215

轻雪同学_7215

2026-07-24

832人浏览

原创

核心方式是使用 declare module 创建模块声明,准确描述 js 包导出的类型结构,支持 default、命名、umd 等导出模式,并通过 tsconfig 配置使声明生效。

typescript中模块声明declaremodule怎么为没有提供类型的纯js npm包手动编写补全

为没有类型定义的纯 JavaScript npm 包手动编写 TypeScript 类型补全,核心方式是使用 declare module 创建全局或路径映射的模块声明。这不是“给 JS 文件加类型”,而是告诉 TypeScript:“这个包导出什么,我来负责描述”。关键在于声明要准确、可维护,并能被正确识别。

基本语法:用 declare module 声明模块形状

在 .d.ts 文件(如 types/my-pkg.d.ts)中写:

  // types/my-pkg.d.ts
declare module 'my-pkg' {
  export const version: string;
  export function doSomething(input: string): number;
  export class Helper {
    constructor(name: string);
    run(): void;
  }
}

这样在任意 .ts 文件中 import { doSomething } from 'my-pkg' 就能获得类型提示和检查。

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载

处理常见导出模式:default、命名、混合、UMD

不同 JS 包导出方式不同,声明需匹配实际行为:

  • 默认导出(CommonJS 或 ES Module):
    若 require('pkg') 返回一个函数或对象,用 export default:
    declare module 'pkg' { export default function foo(): void; }
  • 命名导出 + 默认导出共存:
    常见于 Babel 转译后的包,需同时声明:
    export const named: string;<br>export default function main(): void;
  • UMD / 全局变量式(如通过 script 标签引入):
    配合 export as namespace 支持全局访问:
    declare module 'pkg' { export as namespace Pkg; export function init(): void; }
    之后可在非模块文件中直接用 Pkg.init()。

让声明生效:三类加载方式与配置要点

TypeScript 需知道去哪里找你的 .d.ts 文件:

  • 项目级声明(推荐):把 types/ 目录加入 tsconfig.json 的 "typeRoots" 或确保它在 "include" 中:
    "include": ["src/**/*", "types/**/*"]
  • 全局声明(不推荐用于包):放在项目根目录下 global.d.ts,但会污染全局命名空间,仅适合极简补全。
  • 发布到 DefinitelyTyped(进阶):写好完整类型后,可向 DefinitelyTyped 提交 PR,供所有人复用。

实用技巧:快速反推类型 & 避免常见坑

不必凭空猜类型,可结合运行时观察:

  • 在 Node.js 中 console.log(require('pkg')) 查看真实结构;
  • 用 VS Code 打开包的 index.js,悬停查看 JSdoc 注释(很多库自带);
  • 避免写 any —— 即使暂时不确定,也先用 unknown 或最小接口(如 { data: string });
  • 注意版本兼容性:在声明顶部加注释说明适配的包版本,例如 // @version 2.1.0。

相关文章

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

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

下载

相关标签:

typescript npm vite js

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

相关专题

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

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

2023.06.20

4366

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

4284

6

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

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

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1756

5

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

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

2023.09.04

3165

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4113

6

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

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

2023.09.20

2640

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万人学习