TypeScript 声明文件全解析

更新日期: 2021-06-07阅读: 2.3k标签: TypeScript

导语:全面拥抱 TS 的时代,TS 已经成为日常开发中的重要部分。本文主要介绍 TS 声明文件的写法。


声明文件的定义

通俗地来讲,在 TypeScript 中以 .d.ts   为后缀的文件,我们称之为 TypeScript 声明文件。它的主要作用是描述 JavaScript 模块内所有导出接口的类型信息。


什么时候需要写 TS 声明文件

在日常的开发中,绝大多数时候是不需要我们单独去编写一个 TS 声明文件的。如果我们的文件本身是用 TS 编写的,在编译的时候让 TS 自动生成声明文件,并在发布的时候将 .d.ts   文件一起发布即可。

总结了以下三种情况,需要我们手动定义声明文件:

通过 script 标签引入的第三方库

一些通过 CDN 的当时映入的小的工具包,挂载了一些全局的方法,如果在 TS 中直接使用的话,会报 TS 语法错误,这时候就需要我们对这些全局的方法进行 TS 声明。

使用的第三方 npm 包,但是没有提供声明文件

第三方 npm 包如果有提供声明文件的话,一般会以两种形式存在:一是  @types/xxx ,另外是在源代码中提供   .d.ts   声明文件。第一种的话一般是一些使用量比较高的库会提供,可以通过  npm i @type/xxx  尝试安装。如果这两种都不存在的话,那就需要我们自己来定义了。

自身团队内比较优秀的 JS 库或插件,为了提升开发体验


如何编写 TS 声明文件

对于不同形式的声明文件,写法上会有一定的差异。这里需要特别注意一点的是:声明文件中只是对类型的定义,不能进行 赋值 。

:pushpin: 全局变量

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

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

这里需要注意的是只是定义类型,不能进行 赋值 。

// 变量
declare let userName: string;

declare const wx: any;

// 函数、函数重载
declare function getName(uid: number): string;
declare function getName(): string;
declare function getName(cb: () => any): any;

// 类
declare class Course {
cid: number;
constructor(cid){};
getCoursePrice(): number;
}

// 枚举
declare enum Status {
Loading,
Success,
Failed,
}

// 接口 interface declare 可以不需要
interface CourseInfo {
cid: number;
name: string;
}

interface CGIData<T> {
data: T;
retcode: 0;
}

// 命名空间
declare namespace User {
// 局部 Test.User
interface User {
name: string;
age: number;
}

function getUserInfo(name: string): User {
return "";
}
namespace fn {
function extend(obj: any): any;
}
}


// 声明合并
declare function User(id: number): string;

:pushpin: npm 包

对于没有提供声明文件的 npm 包,我们可以创建一个 types 目录,来管理自己写的声明文件,同时需要在配置文件  tsconfig.json  中的 paths 和 basrUrl 中配置:

{
"compilerOptions": {
"module": "commonjs",
"baseUrl": "./", // types文件夹的相对路径
"paths": { "*": ["types/*"]}
}
}

npm 包的声明文件主要有以下几种语法:

export const/let  // 导出变量
export namespace // 导出(含有自属性的)对象
export default // ES6 默认导出
export = // commonjs 导出模块

:pushpin: 拓展原有模块/全局变量

对于已经有声明定义的模块或者全局变量,可以利用 TS 中的声明合并对其进行拓展。

比如在 window 下挂载的一些全局变量:

interface Window {
readonly request?: any;
readonly devToolsExtension?: any;
readonly wx?: any;
}

对已有模块进行拓展:

declare module "querystring" {
function escape(str: string): string;
function unescape(str: string): string;
}

还可以使用三斜线的方式对声明文件进行引用:

/// <reference path=”custom.d.ts" />


最后

如何让 TS 在编译时自动生成  .d.ts  文件呢?只需要在  tsconfig.json  配置文件中开启即可,TS 编译时就会自动生成   .d.ts   声明文件:

{
"compilerOptions": {
"declaration": true
}
}


参考

TypeScript入门教程–声明文件

原文:https://mp.weixin.qq.com/s/y0c4daxpfvOm-oAo7A6ZFg
公众号:腾讯IMWeb前端团队



链接: https://fly63.com/article/detial/10401

用TypeScript弥补Elm和JavaScript之间的差距

近些日子,我使用了新语言编程,从JavaScript,切确地说是Elm,转成TypeScript。在本文中,我将继续深挖一些我非常喜欢的TypeScript特性。

Typescript 和 Javascript之间的区别

TypeScript 和 JavaScript 是目前项目开发中较为流行的两种脚本语言,我们已经熟知 TypeScript 是 JavaScript 的一个超集,但是 TypeScript 与 JavaScript 之间又有什么样的区别呢?

Nerv_一款类 React 前端框架,基于虚拟 DOM 技术的 JavaScript(TypeScript) 库

Nerv_是一款由京东凹凸实验室打造的类 React 前端框架,基于虚拟 DOM 技术的 JavaScript(TypeScript) 库。它基于React标准,提供了与 React 16 一致的使用方式与 API。

TypeScript_TS系列之高级类型

交叉类型:将多个类型合并为一个类型、联合类型:表示取值可以为多种类型中的一种、混合类型:一个例子就是,一个对象可以同时做为函数和对象使用,并带有额外的属性、类型断言:可以用来手动指定一个值的类型

TypeScript 在 JavaScript 的基础上的改动

在做比较大的,多人合作的项目的时候,TypeScript会更加地适合,这得益于它的可读性,面向对象性以及易于重构的特点。但如果只是自己做小程序,不需要太多人参与的时候,JavaScript则会更加简单。

5分钟了解TypeScript

有两种方式安装TypeScript,如何创建第一个TypeScript文件,在TypeScript中,可以使用interface来描述一个对象有firstName和lastName两个属性,TypeScript支持JavaScript的新功能,其中很重要的一个功能就是基于类的面向对象编程

如何编写 Typescript 声明文件

使用TypeScript已经有了一段时间,这的确是一个好东西,虽说在使用的过程中也发现了一些bug,不过都是些小问题,所以整体体验还是很不错的。有关TypeScript声明类型声明相关的目前就总结了这些比较常用的

谷歌为何会选用TypeScript?

谷歌在很早之前就张开双臂拥抱 Web 应用程序,Gmail 已经发布 14 年了。当时,JavaScript 的世界是疯狂的。Gmail 工程师不得不为 IE 糟糕的垃圾回收算法捏一把汗,他们需要手动将字符串文字从 for 循环中提取出来,以避免 GC 停顿

为什么要学习Typescript 语言呢?Typescript 开发环境安装

TypeScript是一种由微软开发的自由和开源的编程语言。它是JavaScript的一个超集,TypeScript是JavaScript类型的超集,它可以编译成纯JavaScript。TypeScript可以在任何浏览器、任何计算机和任何操作系统上运行,并且是开源的。

使用TypeScript两年后-值得吗?

差不多两年前,我在一个创业团队中开始了一个全新的项目。用到的全都是类似Microservices,docker,react,redux这些时髦的东西。我在前端技术方面积累了一些类似的经验

点击更多...

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