js捆綁TypeScript聲明文件的方法教程

前話

TypeScript是JavaScript類型的超集，這是TypeScript的文檔介紹的一句話，那么他們存在聯(lián)系呢？

我的理解是，TypeScript在JavaScript基礎(chǔ)上引入強類型語言的特性。開發(fā)者使用TypeScript語法進行編程開發(fā)，最終通過轉(zhuǎn)換工具將TypeScript轉(zhuǎn)換成JavaScript。

使用TypeScript能夠避免在原生JavaScript上開發(fā)所帶來的弱類型語言的坑。（我該輸入啥？調(diào)用后返回啥？哎還是看看源碼吧。。）

嗯！很好，強類型的JavaScript，挺好的。但是，我舍不得那NPM里眾多庫無微不至的人文關(guān)懷啊o(TヘTo)

別怕，現(xiàn)在很多庫已經(jīng)悄悄地支持TypeScript，就算它無心支持，也有無私奉獻的大佬們悄悄地幫這些庫支持TypeScript了

這就是引出了本文的主題，TypeScript的聲明文件，我認為它是JavaScript庫類似C語言的頭文件，它的存在便是幫助TypeScript引入JavaScript庫

什么是聲明文件？

和 C/C++ 的 *.h 頭文件（Header files）非常相似：當你在 C/C++ 程序中引用了一個第三方庫（.lib/.dll/.so/.a/.la）時，C/C++ 編譯器無法自動地識別庫內(nèi)導出名稱和函數(shù)類型簽名等，這就需要使用頭文件進行接口聲明了。

同理地，TypeScript 的聲明文件是一個以 .d.ts 為后綴的 TypeScript 代碼文件，但它的作用是描述一個 JavaScript 模塊（廣義上的）內(nèi)所有導出接口的類型信息。

關(guān)于TypeScript聲明文件的寫法和規(guī)范請參考參考如下官方文檔和優(yōu)秀博文：

根據(jù)官方文檔介紹，有以下兩個捆綁方式：

與npm包捆綁一起就是前面說的，開發(fā)者在ts項目中npm install一個庫并在代碼文件中import后直接即可使用。

當部分庫官方不維護的時候，就可以通過第二個方式，在npm install一個庫后，再執(zhí)行 npm install @types/庫名 安裝庫的聲明文件即可使用。其原理是TypeScript在2.0版本之后，當你import 一個庫的時候，當他在配置的include路徑中未找到指定的庫，就會在node_modules的@types中尋找該庫。

一般來說，官方推薦第一種方式書寫發(fā)布聲明文件，下面我直接用例子來展示第一種捆綁方式吧。

例子

首先初始化TypeScript項目，目錄結(jié)構(gòu)如下：

tsconfig.json配置如下：

{
 "compilerOptions": {
 "target": "es5",
 /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
 "module": "commonjs",
 /* Specify module code generation: 'none', commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
 "allowJs": true,
 "outDir": "./dist",
 /* Redirect output structure to the directory. */
 /* Allow javascript files to be compiled. */
 "strict": true /* Enable all strict type-checking options. */
 },
 "include": [
 "src/**/*"
 ]
}

可以看到，我寫了個模塊 a ，并且給它捆綁了聲明文件，模塊 a ，即 src/a/index.js 內(nèi)容如下：

const NAME = 'A';
let call = (who) => {
 console.log('Hello ' + who + '! I am ' + NAME);
}
export default {
 call
}

其聲明文件即 src/a/index.d.ts 內(nèi)容如下：

declare namespace a {
 function call(who: string): void;
}
export default a;

這時，我們便可以在入口文件 src/index.ts 引入 a 模塊：

import a from './a';
a.call('Pwcong');

命令行執(zhí)行 tsc 后即可在目錄 dist 中生成js代碼：

執(zhí)行命令 node ./dist/index.js 可以得到相應(yīng)正確的輸出。

我們再模擬導入發(fā)布后的NPM庫，在 node_modules 目錄下創(chuàng)建目錄 b ，并初始化Node項目，這時目錄結(jié)構(gòu)如下：

其中 node_modules/b/types/package.json 內(nèi)容如下：

{
 "name": "b",
 "version": "1.0.0",
 "main": "./src/index.js",
 "types": "./types/index.d.ts"
}

node_modules/b/src/index.js 內(nèi)容如下：

const NAME = 'B';
let call = (who) => {
 console.log('Hello ' + who + '! I am ' + NAME);
}
module.exports = {
 call
}

聲明文件 node_modules/b/types/index.d.ts 內(nèi)容如下：

declare namespace b {
 function call(who: string): void;
}
export = b;

這時，我們修改 src/index.ts ：

import a from './a';
a.call('Pwcong');
import b = require('b');
b.call('Pwcong');

命令行執(zhí)行 tsc 后即可在目錄 dist 中生成js代碼后執(zhí)行命令 node ./dist/index.js 也可以得到相應(yīng)正確的輸出。

總結(jié)

聲明：本網(wǎng)頁內(nèi)容旨在傳播知識，若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com