我们知道,Typescript是微软开发的语言,主要是为了自动帮助大家类型检查以及更好的使用面向对象,让使用面向对象开发的人员可以更好的理解Javascript,当然在实际开发过程中TypeScript还是会编译为Javascript,这样才会正常运行,编译的时候,会进行类型检查。
由于Javascrtipt解释型语言的特性,每个相同类型的对象可以有不同的属性,但是TypeScript在编译的过程中可以实现类型检查,开发过程中进行类型提示,提高开发人员的开发效率。
我们新的project一般都会用TypeScript, 由于现在很多的流行的库实际上还是Javascript,为了提高开发人员的开发效率,我们自己可以为这些Javascript制作声明文件(可以看做是C++的头文件,只编译,不连接)。
写JavaScript的声明文件有很多方法,但是扩展名都是.d.ts,写声明文件,主要还是看对Javascript文件使用的方式,我常用的有两种方式:
1. 对类型库写声明文件,例如库文件中有一个文件api.js, 我们可以在api.js目录下创建api.d.ts,如下例子:
//api.js
//test declare file
window.MyName = "Spring Dou";
// export class A
export class A {
constructor()
{
this.name = "Spring";
this.sex = "Man";
}
/**
* @param {string} n
*/
set Name(n)
{
this.name = n;
}
}
// export function B
export function B(a, b) {return a+b;}
function AB(a){
return a;
}
// export object pp
export let PP={
value: 23
}
我会产生如下的声明文件:
// api.d.ts
// import的时候作为独立命名空间
export as namespace API_1
// export class A并用declare告诉开发该类是在其他地方定义的
export declare class A {
name: string;
sex: string;
Name: string;
}
// export function B 并用declare告诉开发该函数是在其他地方定义的
export declare function B(a: number, b: number): number;
// export 定义接口MJ
export interface MJ {
value: number;
name: string;
}
// export 变量PP,并且PP的类型是MJ,该例子中api.js对PP的定义实际上没有类型说明,
// 在开发的时候有了这个声明,类型检查就会按照MJ进行检查。
export declare var PP: MJ;
使用的时候直接使用import * as API from './api',那么所有的变量和类,接口,函数都会进行类型检查和提示。
2. 为project声明全局变量
例如上例子api.js中的window.MyName = "Spring Dou",project包含了该文件之后,实际上定义了一个全局变量MyName,要想在其他地方有提示,有该全局变量,可以创建一个文件global.d.ts(也可以其他名字), 在该文件中(没有import 函数的话)做如下声明:
declare let MyName: string;
不用做任何import,就可以有提示和检查。
这只是个简单的例子,假如我们在类型声明的时候用到了其他类,比如我们要定义一个全局对象,类型是在其他文件中定义的
window.MyName = new type();
那么我们在声明文件的时候就需要用到import,这个时候直接declare就不行了,需要如下方法定义:
import * as tempApi from './api'
declare global {
let apime: tempApi.A; // 上例中的class A
let MyName: string; // window.MyName
}
如果用以上的两种方法基本都可以。