时间戳

首页 > 解决方案 > TypeScript 声明文件不适用于 NPM 模块

typescript - TypeScript 声明文件不适用于 NPM 模块

问题描述

我一直在为 NPM 创建一个包。（这是一个 JSON 包装的数据库），这是一个有趣的小项目。我想包含函数的声明（如<QDb>.Connect();），但无法掌握添加它的窍门。目录结构：

node_modules
QDatabase
    Docs
        QDb.d.ts
    Utils
package-lock.json
package.json
QDb.js

在声明文件中，我有基本的东西，比如export function Connect(Path: String, Callback?: function): void | Error;. 在文件的顶部，我添加了import {Connect} from "../../QDb.js";（与所有其他功能，我只是在这里使用 Connect 为例）。

当我将包链接到我的主文件夹时，然后将其链接到测试项目中；它不显示函数的任何声明，只显示基本的 JavaScript，但不显示@description, @param, @emits,@returns等。

有什么我做错了吗？非常感谢您的帮助。

～问

标签： typescriptnpmdeclaration

解决方案

确保你"types": "./QDatabase/Docs/QDb.d.ts"的 package.json 中有一个。有关发布包的 TypeScript 文档的更多信息

推荐阅读