TypeScript 類型定義文件(*.d.ts)自動生成工具

在開發ts時,有時會遇到沒有d.ts文件的庫,同時在老項目遷移到ts項目時也會遇到一些文件須要本身編寫聲明文件,可是在須要的聲明文件比較多的狀況,就須要自動生產聲明文件。用過幾個庫。今天簡單記錄一下。本身怎麼編寫有不少教程和文檔,那裏就不介紹了。

一、爲整個包添加聲明文件

使用微軟的dts-genjavascript

簡單使用java

npm install -g dts-gen   // 先全局安裝dts-gen npm install -g yargs // 而後在全局安裝你須要生產聲明文件的庫 dts-gen -m yargs // 執行命令生成文件

在你執行的文件的路徑下(通常是項目的根目錄)生成了yargs.d.tsgit

其餘參數和功能自行參考文檔github

二、爲單個文件生產聲明文件

使用dtsmakenpm

簡單使用markdown

npm i dtsmake -g   // 先全局安裝dtsmake dtsmake -s ./path/to/sourcefile.js // 在對應的文件生產文件

說明:app

  • 生成的文件通常都會有一些問題,須要本身稍微修改一下,若是不想寫類型直接用any
  • 執行的時候可能會報錯tern沒有按裝,就須要在安裝一下,在項目目錄 npm i tern --save-dev

其餘參數和功能自行參考文檔post

其餘

  • 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.
相關文章
相關標籤/搜索