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

时间:2019-03-02 09:47:22

标签: typescript npm declaration

我一直在为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等。

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

〜Q

1 个答案:

答案 0 :(得分:0)

确保package.json中有"types": "./QDatabase/Docs/QDb.d.ts"。有关TypeScript's docs on publishing packages

的更多信息