为第三方库生成声明文件.d.ts

首先,你当然可以手写一个.d.ts,但这不是这里要讨论的,关于.d.ts该怎么写,参见文档:https://www.tslang.cn/docs/handbook/declaration-files/introduction.html

比如你想在你的TypeScript项目中使用enquirer这个包,但是这个包没有提供.d.ts文件

PS F:\tgit\smarttalk\tools\decide> npm i @types/enquirer -D
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@types%2fenquirer - Not found
npm ERR! 404  '@types/enquirer@*' is not in this registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\fygame\AppData\Local\npm-cache\_logs\2021-12-16T03_44_43_085Z-debug-0.log

我们可以使用现有的工具来生成声明文件,个人推荐使用dts-gen,其npm主页:
https://www.npmjs.com/package/dts-gen

全局安装
npm i dts-gen -g

根据其文档,你很快就知道该怎么用,我们就用dts-gen生成一个吧~

先使用最简单的命令:dts-gen -m enquirer,但是你会遇到如下报错:

PS F:\tgit\smarttalk\tools\decide> dts-gen -m enquirer
Unexpected crash! Please log a bug with the commandline you specified.
C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\run.js:130
        throw e;
        ^

TypeError: Cannot read property 'cursor' of undefined
    at EventEmitter.get cursor [as cursor] (F:\tgit\smarttalk\tools\decide\node_modules\enquirer\lib\prompt.js:398:23)
    at getProperty (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:254:30)
    at Array.map (<anonymous>)
    at getPropertyDeclarationsOfObject (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:250:25)
    at getTypeOfValue (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:237:33)
    at getProperty (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:257:45)
    at Array.map (<anonymous>)
    at getPropertyDeclarationsOfObject (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:250:25)
    at getTypeOfValue (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:237:33)
    at getResult (C:\Users\fygame\AppData\Roaming\npm\node_modules\dts-gen\bin\lib\index.js:173:32)

这类报错并不是总是会发生的,关键看你要生成声明文件的包的具体使用方式。详细看了下上述堆栈,你可以很快明白为什么会有上述错误产生。这里,dts-gen文档里关于--expression-file选项的使用就非常重要了。于是我们可以很简单地把enquirer的示例写在一个js文件中,如下:

const { prompt } = require('enquirer');
 
const response = await prompt({
  type: 'input',
  name: 'username',
  message: 'What is your username?'
});
 
console.log(response);

然后我们用这个命令dts-gen --expression-file "index.js" -m enquirer,便可成功生成声明文件:

PS F:\tgit\smarttalk\tools\decide> dts-gen --expresion-file "index.js" -m enquirer
Wrote 8276 lines to enquirer.d.ts.

生成的.d.ts文件片段如下:

/** Declaration file generated by dts-gen */

export = enquirer;

declare class enquirer {
    constructor(...args: any[]);

    ask(...args: any[]): void;

    prompt(...args: any[]): void;

    register(...args: any[]): void;

    use(...args: any[]): void;

    static BasicAuth(...args: any[]): any;

    static Confirm(...args: any[]): void;

    static MultiSelect(...args: any[]): void;

    static addListener(p0: any, p1: any): any;

    static autocomplete(options: any): void;

    static basicauth(options: any): void;

    static captureRejectionSymbol: any;

    static captureRejections: boolean;

    static confirm(options: any): void;

    static defaultMaxListeners: number;

    static editable(options: any): void;
...
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容