You need to enable JavaScript to run this app. TypeScript如何为CommonJS风格JS包编写声明文件并导入全部导出函数
优惠活动
大模型
产品
解决方案
定价
更多

TypeScript如何为CommonJS风格JS包编写声明文件并导入全部导出函数

CommonJS 风格 JS 包的 TypeScript 类型声明正确实现

原写法的核心问题

你之前写的类型声明没法被TS正确识别,本质是直接照搬了JS的写法,没有适配TS对CommonJS结构的声明规则,具体错处:

  • 在.d.ts里写'use strict'是完全多余的,这个是JS运行时的语法,对类型声明没有任何作用
  • 用import Plugins from './Plugins'的默认导入语法不对:原Plugins.js是给导出对象挂载多个函数属性的结构,和ES模块默认导入的语义不匹配
  • 直接在类型文件里写module.exports = { plugins: Plugins }不符合TS类型文件的语法要求,TS根本推导不出正确的导出结构
  • 没有为每个导出的函数定义对应的类型签名,就算结构对了,调用时也会因为类型缺失报错

分文件编写正确的类型声明

1. 为Plugins.js编写同目录的Plugins.d.ts

原Plugins.js的逻辑是给导出对象挂载三个独立函数,对应的类型声明直接导出同名称的函数即可,你只需要根据实际业务逻辑补全每个函数的入参、返回值类型:

// Plugins.d.ts
export function function1(/* 填写实际入参的类型 */): /* 填写实际返回值的类型 */;
export function function2(/* 填写实际入参的类型 */): /* 填写实际返回值的类型 */;
export function function3(/* 填写实际入参的类型 */): /* 填写实际返回值的类型 */;

2. 为入口index.js编写同目录的根index.d.ts

原入口文件的逻辑是导出一个带plugins属性的对象,属性值是Plugins模块的全量导出。这里必须用TS专门对应CommonJS导出的export =语法,不能用普通ES模块导出:

// 根目录下和index.js同级的index.d.ts
// 用* as 导入Plugins类型,匹配它作为带属性对象的结构
import * as Plugins from './Plugins';

// 定义入口导出的实际结构
const packageExport = {
  plugins: Plugins
};

// 用export = 对应CommonJS里module.exports = 某对象的赋值逻辑
export = packageExport;

业务代码中的正确导入方式

根据你项目的TS编译配置,对应不同的导入写法:

  • 如果开启了esModuleInterop(现在绝大多数TS模板项目的默认配置),可以直接用默认导入:
    import myPackage from '你的包名';
    // 直接按预期调用即可
    myPackage.plugins.function1();
    
  • 如果没有开启上述配置,用CommonJS风格的导入语法:
    import myPackage = require('你的包名');
    myPackage.plugins.function1();
    

必要配置提醒

  • 确保TS能找到你的类型文件:要么在包的package.json里配置"types": "index.d.ts"指向根类型文件,要么保持index.d.ts和index.js同目录(TS会按默认规则查找同名的类型声明文件)
  • 不要在同一个类型声明文件里同时混用export =和ES模块的export语法,会直接触发类型编译报错

内容的提问来源于stack exchange,提问作者InvisibleExo

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.10 10:54:05