d.ts文件可以注释html吗,如何编写一个d.ts文件的步骤详解_旧店_前端开发者

前言

本文主要讲怎么写一个typescript的描述文件(以d.ts结尾的文件名，比如xxx.d.ts)。

最近开始从

之前也从网上面也找了一些资料，但还是看的云里雾里模糊不清，经过一段摸索，将摸索的结果记录下来，也希望可以给别人一个参考。

如果你只写

详情可以看我以前写过的一些文章：//www.jb51.net/article/138211.htm

通常，我们写

1，在

2，通过模块加载器require其他

全局类型

首先以第一种方式举例。

变量

比如现在有一个全局变量，那对应的d.ts文件里面这样写。

declare var aaa:number

其中关键字declare表示声明的意思。全局变量是aaa,类型是数字类型(number)。当然了也可以是string类型或者其他或者：

declare var aaa:number|string //注意这里用的是一个竖线表示"或"的意思

如果是常量的话用关键字const表示：

declare const max:200

由上面的全局变量的写法我们很自然的推断出一个全局

/** id是用户的id，可以是number或者string */

decalre function getName(id:number|string):string

最后的那个string表示的是

在

我们上面写的注释，写js的时候还可以提示。

有时候同一个

get(1234)

get("zhangsan",18)

那么d.ts对应的写法：

declare function get(id: string | number): string

declare function get(name:string,age:number): string

如果有些参数可有可无，可以加个?表示非必须。

declare function render(callback?:()=>void): string

js中调用的时候，回调传不传都可以：

render()

render(function () {

alert('finish.')

})

class

当然除了变量和

declare class Person {

static maxAge: number //静态变量

static getMaxAge(): number //静态方法

constructor(name: string, age: number) //构造函数

getName(id: number): string

}

constructor表示的是构造方法：

其中static表示静态的意思，用来表示静态变量和静态方法：

对象

declare namespace OOO{

}

当然了这个对象上面可能有变量，可能有函数可能有类。

declare namespace OOO{

var aaa: number | string

function getName(id: number | string): string

class Person {

static maxAge: number //静态变量

static getMaxAge(): number //静态方法

constructor(name: string, age: number) //构造函数

getName(id: number): string //实例方法

}

}

其实就是把上面的那些写法放到这个namespace包起来的大括号里面，注意括号里面就不需要declare关键字了。

效果：

对象里面套对象也是可以的：

declare namespace OOO{

var aaa: number | string

// ...

namespace O2{

let b:number

}

}

效果：

混合类型

有时候有些值既是函数又是class又是对象的复杂对象。比如我们常用的

new $()

$.ajax()

$()

既是函数又是对象

declare function $2(s:string): void

declare namespace $2{

let aaa:number

}

效果：

作为函数用：

作为对象用：

也就是ts会自动把同名的namespace和function合并到一起。

既是函数，又是类(可以new出来)

// 实例方法

interface People{

name: string

age: number

getName(): string

getAge():number

}

interface People_Static{

new (name: string, age: number): People

/** 静态方法 */

staticA():number

(w:number):number

}

declare var People:People_Static

效果：

作为函数使用：

类的静态方法：

类的构造函数：

类的实例方法：

模块化

除了上面的全局的方式，我们有时候还是通过require的方式引入模块化的代码。

比如这样的效果：

对应的写法是这样的：

declare module "abcde" {

export let a: number

export function b(): number

export namespace c{

let cd: string

}

}

其实就是外面套了一层 module “xxx”，里面的写法和之前其实差不多，把declare换成了export。

此外，有时候我们导出去的是一个函数本身，比如这样的：

对应的写法很简单，长这个样子：

declare module "app" {

function aaa(some:number):number

export=aaa

}

以此类推，导出一个变量或常量的话这么写：

declare module "ccc" {

const c:400

export=c

}

效果：

UMD

有一种代码，既可以通过全局变量访问到，也可以通过require的方式访问到。比如我们最常见的

其实就是按照全局的方式写d.ts，写完后在最后加上declare namespace “xxx”的描述：

declare namespace UUU{

let a:number

}

declare module "UUU" {

export =UUU

}

效果这样：

作为全局变量使用：

作为模块加载使用：

其他

有时候我们扩展了一些内置对象。比如我们给Date增加了一个format的实例方法：

对应的d.ts描述文件这样写：

interface Date {

format(f: string): string

}

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对前端开发者的支持。