首页 > 其他分享 >TypeScript 声明文件

TypeScript 声明文件

时间:2023-02-27 15:11:07浏览次数:39  
标签:jQuery 文件 TypeScript ts Calc 声明

TypeScript 声明文件

TypeScript 作为 JavaScript 的超集,在开发过程中不可避免要引用其他第三方的 JavaScript 的库。虽然通过直接引用可以调用库的类和方法,但是却无法使用TypeScript 诸如类型检查等特性功能。为了解决这个问题,需要将这些库里的函数和方法体去掉后只保留导出类型声明,而产生了一个描述 JavaScript 库和模块信息的声明文件。通过引用这个声明文件,就可以借用 TypeScript 的各种特性来使用库文件了。

假如我们想使用第三方库,比如 jQuery,我们通常这样获取一个 id 是 foo 的元素:

$('#foo');
// 或
jQuery('#foo');

但是在 TypeScript 中,我们并不知道 $ 或 jQuery 是什么东西:

jQuery('#foo');

// index.ts(1,1): error TS2304: Cannot find name 'jQuery'.

这时,我们需要使用 declare 关键字来定义它的类型,帮助 TypeScript 判断我们传入的参数类型对不对:

declare var jQuery: (selector: string) => any;

jQuery('#foo');

declare 定义的类型只会用于编译时的检查,编译结果中会被删除。

上例的编译结果是:

jQuery('#foo');

声明文件

声明文件以 .d.ts 为后缀,例如:

runoob.d.ts

声明文件或模块的语法格式如下:

declare module Module_Name {
}

TypeScript 引入声明文件语法格式:

/// <reference path = " runoob.d.ts" />

当然,很多流行的第三方库的声明文件不需要我们定义了,比如 jQuery 已经有人帮我们定义好了:jQuery in DefinitelyTyped

实例

以下定义一个第三方库来演示:

CalcThirdPartyJsLib.js 文件代码:

var Runoob; (function(Runoob) { var Calc = (function () { function Calc() { } }) Calc.prototype.doSum = function (limit) { var sum = 0; for (var i = 0; i <= limit; i++) { sum = sum + i; } return sum; } Runoob.Calc = Calc; return Calc; })(Runoob || (Runoob = {})); var test = new Runoob.Calc();

如果我们想在 TypeScript 中引用上面的代码,则需要设置声明文件 Calc.d.ts,代码如下:

Calc.d.ts 文件代码:

declare module Runoob { export class Calc { doSum(limit:number) : number; } }

声明文件不包含实现,它只是类型声明,把声明文件加入到 TypeScript 中:

CalcTest.ts 文件代码:

/// <reference path = "Calc.d.ts" /> var obj = new Runoob.Calc(); // obj.doSum("Hello"); // 编译错误 console.log(obj.doSum(10));

下面这行导致编译错误,因为我们需要传入数字参数:

obj.doSum("Hello");

使用 tsc 命令来编译以上代码文件:

tsc CalcTest.ts

生成的 JavaScript 代码如下:

CalcTest.js 文件代码:

/// <reference path = "Calc.d.ts" /> var obj = new Runoob.Calc(); //obj.doSum("Hello"); // 编译错误 console.log(obj.doSum(10));

最后我们编写一个 runoob.html 文件,引入 CalcTest.js 文件及第三方库 CalcThirdPartyJsLib.js:

实例

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>菜鸟教程(runoob.com)</title> <script src = "CalcThirdPartyJsLib.js"></script> <script src = "CalcTest.js"></script> </head> <body> <h1>声明文件测试</h1> <p>菜鸟测试一下。</p> </body> </html> 浏览器打开该文件输出结果如下:

标签:jQuery,文件,TypeScript,ts,Calc,声明
From: https://www.cnblogs.com/chenchuang/p/17159758.html

相关文章

  • 解决Windows缺少找不到xinput1_3.dll文件
    其实很多用户玩单机游戏或者安装软件的时候就出现过这种问题,如果是新手第一时间会认为是软件或游戏出错了,其实并不是这样,其主要原因就是你电脑系统的该dll文件丢失了或者损......
  • C# 删除文件夹里的内容
    ///<summary>///删除文件夹下的文件///</summary>///<paramname="FolderName">文件夹路径</param>privatevoidclearFolde......
  • C#使用GDAL读取TIF文件
    GDAL官网C#使用GDAL库需安装以下两个Nuget包:GDAL和GDAL.Native也可以安装这几个包:这两种方式的注册方式会不太一样,其他用法大致相同。在此选中的是第一种方式,即在此安......
  • 直播系统源代码,读取多行文本、读取文件分割多行文本
    直播系统源代码,读取多行文本、读取文件分割多行文本读取文本 publicfunctiondaoru(){/* *逐行读取TXT文件  */     $rep=str_replace("\n",',',"TD......
  • linux环境中,如何将一个大文件拆分成多个小文件?
    背景及需求说明: 要对主机上的数据进行迁移,压缩完成之后,发现有将近500G大小的数据,然后没有其他的磁盘了,其他的主机上的空间,也都只有200G左右,所以这个时候......
  • 推荐 7 个学习 TypeScript 的宝库,2021 学 TS 看这篇就够了!
    前言猫哥是一个常年混迹在GitHub上的猫星人,所以发现了不少好的前端开源项目、常用技巧,在此分享给大家。公众号:前端GitHub,专注于挖掘GitHub上优秀的前端开源项目,并以......
  • TypeScript 基础语法
    TypeScript基础语法TypeScript程序由以下几个部分组成:模块函数变量语句和表达式注释第一个TypeScript程序我们可以使用以下TypeScript程序来输出"HelloW......
  • TypeScript 基础类型
    TypeScript基础类型TypeScript包含的数据类型如下表:数据类型关键字描述任意类型any声明为any的变量可以赋予任意类型的值。数字类型number双精度64位......
  • 通过EXCEL/WPS文件,拼接SQL,刷数据库数据
    WPS如何把日期变成文本格式?【快捷选择同一列多条记录】同一列,鼠标左键标记A,SHIFT+鼠标左键标记B,等于选择A-B的之间的数据【向下填充】在第一行输入数据,选择同一列A-B......
  • python遍历目录获取上几层文件
    功能:python遍历目录,获取上N层的文件,例如获取第一层,第二层,第三层的文件。代码importosdeftraverse_folders_by_layer(folder,layer=999,index=1,data=None):......