在開發ts時,有時會遇到沒有d.ts文件的庫,同時在老項目遷移到ts項目時也會遇到一些文件需要自己編寫聲明文件,但是在需要的聲明文件比較多的情況,就需要自動生產聲明文件。用過幾個庫。今天簡單記錄一下。自己怎么編寫有很多教程和文檔,那里就不介紹了。
1、為整個包添加聲明文件
使用微軟的dts-gen
簡單使用
npm install -g dts-gen // 先全局安裝dts-gen npm install -g yargs // 然后在全局安裝你需要生產聲明文件的庫 dts-gen -m yargs // 執行命令生成文件
在你執行的文件的路徑下(一般是項目的根目錄)生成了yargs.d.ts
其他參數和功能自行參考文檔
2、為單個文件生產聲明文件
使用dtsmake
簡單使用
npm i dtsmake -g // 先全局安裝dtsmake dtsmake -s ./path/to/sourcefile.js // 在對應的文件生產文件
說明:
- 生成的文件一般都會有一些問題,需要自己稍微修改一下,如果不想寫類型直接用any
- 執行的時候可能會報錯tern沒有按裝,就需要在安裝一下,在項目目錄 npm i tern --save-dev
其他參數和功能自行參考文檔
其他
- dtsgenerator - d.ts file generator tool, for only JSON Schema files.
- js2tsd - d.ts file generator tool, no type inferrence.
- JS2TSD d.ts file generator GUI tool app. Not CLI.