TypeScript声明文件

时间: 2019-07-07阅读: 1822标签: 文件

声明文件简介

当使用第三方库时,我们需要引用它的声明文件,才能获得对应的代码补全、接口提示等功能。


什么是声明语句

假如我们想使用第三方库 jQuery,一种常见的方式是在 html 中通过 <script> 标签引入 jQuery,然后就可以使用全局变量 $ 或 jQuery 了。如:

$('body')

但是在 ts 中,编译器并不知道 $ 或 jQuery 是什么东西:

$('body') //Cannot find name '$'. Do you need to install type definitions for jQuery? Try `npm i @types/jquery`.

这时,我们需要使用 declare var 来定义它的类型:

declare var $: (selector: string) => any;
$('body')

declare var 并没有真的定义一个变量,只是定义了全局变量 $ 的类型,仅仅会用于编译时的检查,在编译结果中会被删除。


什么是声明文件

通常我们会把声明语句放到一个单独的文件(index.d.ts)中,这就是声明文件:

interface myInfoType {
    name?: string;
    age?: number;
    [params:string]: any;
}
declare const myInfo: myInfoType;
declare const $: (selector: string) => any;

声明文件必须以.d.ts为后缀。

ts 会解析项目中所有的 *.ts 文件,当然也包含以 .d.ts 结尾的文件。所以当我们将 jQuery.d.ts 放到项目中时,其他所有 *.ts 文件就都可以获得 $ 的类型定义了。

├── src # 业务资源文件目录
│    ├── category //项目分类
│    │    ├── demo1
│    │    ├── demo2
│    │    └── ...
│    ├── components //公共组件
│    ├── util //公共资源
│    └── custom.d.ts //项目全局变量声明文件
├── index.html //项目启动入口
├── .gitignore //git忽略文件
├── .eslintrc.js //eslint校验配置
├── package.json //依赖包
├── tsconfig.json //ts配置
├── webpack.config.build.js //webpack打包
├── webpack.config.base.js //webpack基础配置
└── webpack.config.js //项目启动配置

假如仍然无法解析,那么可以检查下 tsconfig.json 中的 files、include 和 exclude 配置,确保其包含了 index.d.ts 文件。

也是就是说声明文件要代码使用的顶级目录下。


第三方声明文件

我们可以直接下载下来使用,但是更推荐的是使用 @types 统一管理第三方库的声明文件。

@types 的使用方式很简单,直接用 npm 安装对应的声明模块即可,以 jQuery 举例:

npm install @types/jquery --save-dev


书写声明文件

在不同的场景下,声明文件的内容和使用方式会有所区别。

库的使用场景主要有以下几种:

  • [全局变量]():通过 <script> 标签引入第三方库,注入全局变量
  • [npm 包]():通过 import foo from 'foo' 导入,符合 ES6 模块规范
  • [UMD 库]():既可以通过 <script> 标签引入,又可以通过 import 导入
  • [直接扩展全局变量]():通过 <script> 标签引入后,改变一个全局变量的结构
  • [在 npm 包或 UMD 库中扩展全局变量]():引用 npm 包或 UMD 库后,改变一个全局变量的结构
  • [模块插件]():通过 <script> 或 import 导入后,改变另一个模块的结构


全局变量

使用全局变量的声明文件时,如果是以 npm install @types/xxx --save-dev 安装的,则不需要任何配置。否则就需要在声明文件中声明全局变量。

全局变量的声明文件主要有以下几种语法

  • [declare var/const/let]() 声明全局变量
  • [declare function]() 声明全局方法
  • [declare class]() 声明全局类
  • [declare enum]() 声明全局枚举类型
  • [declare namespace]() 声明(含有子属性的)全局对象
  • [interface 和 type]() 声明全局类型


declare var/const/let

用来定义一个全局变量的类型;

interface myInfoType {
    name?: string;
    age?: number;
    [params:string]: any;
}
declare var myInfo:myInfoType;
declare let myInfo:myInfoType;
declare const myInfo:myInfoType; //此时全局变量是一个常量不允许修改

一般来说,全局变量都是禁止修改的常量,所以大部分情况都应该使用 const 而不是 var 或 let。

需要注意的是,声明语句中只能定义类型,切勿在声明语句中定义具体的实现

declare const test = function(para) {
    return para;
}
//An implementation cannot be declared in ambient contexts.


declare function

declare function 用来定义全局函数的类型。

declare function test(para: string):any;

统一也是只能定义类型 不能定义具体实现;

declare function test(para: string):any{
    return para;
}
//An implementation cannot be declared in ambient contexts.ts(1183)


declare class

当全局变量是一个类的时候,我们用 declare class 来定义它的类型

declare class student {
    name: string;
    constructor(name: string);
    hello(): string;
}

同样的,declare class 语句也只能用来定义类型,不能用来定义具体的实现,比如定义 hello` 方法的具体实现则会报错:

declare class student {
    name: string;
    constructor(name: string);
    hello(){
        return this.name;
    };
}
//An implementation cannot be declared in ambient contexts.ts(1183)


declare namespace

namespace 是 ts 早期时为了解决模块化而创造的关键字,中文称为命名空间。

随着 ES6 的广泛应用,现在已经不建议再使用 ts 中的 namespace,而推荐使用 ES6 的模块化方案了,故我们不再需要学习 namespace 的使用了。

namespace 被淘汰了,但是在声明文件中,declare namespace 还是比较常用的,它用来表示全局变量是一个对象,包含很多子属性。

declare namespace jQuery {
    function ajax(url: string, settings?: any): void;
}


interface 和 type

除了全局变量之外,可能有一些类型我们也希望能暴露出来。在类型声明文件中,我们可以直接使用 interface 或 type 来声明一个全局的接口或类型

interface fetchOptions {
    method?: 'GET' | 'POST';
    credentials?: string;
    headers?: any;
    [params: string]: any;
}
let options: fetchOptions = {
    method: 'GET',
    credentials: 'include'
}


防止命名冲突

暴露在最外层的 interface 或 type 会作为全局类型作用于整个项目中,我们应该尽可能的减少全局变量或全局类型的数量。故最好将他们放到 namespace 下

declare namespace fetchSetting {
    interface fetchOptions {
        method?: 'GET' | 'POST';
        credentials?: string;
        headers?: any;
        [params: string]: any;
    }
}
let options: fetchSetting.fetchOptions = {
    method: 'GET',
    credentials: 'include'
}
站长推荐

1.云服务推荐: 国内主流云服务商,各类云产品的最新活动,优惠券领取。地址:阿里云腾讯云华为云

链接: http://www.fly63.com/article/detial/4570

vue引入静态js文件

由于一些演示,需要对编码名称等可快速进行修改,需要页面方便配置。由于build后的vue项目基本已经看不出原样,因此需要创建一个文件,并在打包的时候不会进行编译。

Flutter 中如何加载并预览本地的 html 文件

直接进入主题,大概步骤如下:在 assets 创建需要访问 html 文件,这里创建一个files文件夹,专门来放这些静态 html 文件.在 pubspec.yaml 中配置访问位置

vue组件内部引入外部js文件

之所以要做这个是因为,在一个组件内部需要引入一个js文件来定位。如果放在index.html,这样每个组件都会有这个js。所以需要在组件内单独引入。

angular2如何访问js文件

angular2访问js文件:先将要使用的js文件下载下来,放到angular2项目的src/assets/js目录,然后告诉angular去哪里加载该库并对要使用的对象进行声明,就可以直接访问js文件了。

javascript中如何读取文件?

因为JavaScript中的Web API有了新的方法File API,所以我们在浏览器上读取文件并处理数据更加方便而且不需要使用到后端服务器。FileReader就是从一个文件中读取数据并存储在一个JavaScript变量中

前端使用js读取文件操作

首先我们定义一个input标签type=file、然后我们定义一个jsReadFiles的方法将文件作为参数;当上传文件的时候读取这个文件。图片上传成功,只是图片路径变成了base64编码的形式。

vue 查看dist文件里的结构

优化打包后的代码,提高性能。方式一:report-json。package.json文件里加入以下命令,然后控制台运行 npm run report结果:会在dist文件夹里生成 report.json。里面有打包后每个文件的来源。

使用FileSave.js将网页内容保存到文件

在写Chrome extension时候,偶尔需要将网页的内容保存到文件。要实现此功能,正常的流程是创建Blob对象存放内容,创建url,创建一个 a 标签,然后将连接与Blob对象关联并放到 a标签的href或者download(H5)属性中

在不使用mv命令的情况下移动文件

有时当你需要移动一个文件时,mv 命令似乎不是最佳选项,那么你会如何做呢?不起眼的 mv 命令是在你见过的每个 POSIX 系统中都能找到的有用工具之一。它的作用是明确定义的,并且做得很好

Node.js之删除文件夹(含递归删除)

应用场景:比如像Eclipse这样的IDE,右击项目,出现选项,点击选项中的删除,就可以删除这个项目及其下的子目录包含文件(使用electron开发的桌面端项目多少都会用到)。

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!