如何编写一个d.ts文件的步骤详解

日期：2020-06-06 栏目：程序人生浏览：次

最近开始从js转ts了。但是要用到一些描述文件（d.ts），常用的比如jquery等都可以通过 npm下载到别人已经写好的npm install @types/jquery。但是还是有一些小众的或者公司内部的公共库或者以前写过的公用js代码需要自己手动写描述文件。

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

如果你只写js，d.ts对你来说也是有用的，大部分编辑器能识别d.ts文件，当你写js代码的时候给你智能提示。效果像这样：

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

通常，我们写js的是时候有两种引入js的方式：

1，在html文件中通过<script>标签全局引入全局变量。

2，通过模块加载器require其他js文件：比如这样var j=require('jquery')。

全局类型

首先以第一种方式举例。

变量

比如现在有一个全局变量，那对应的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表示的是函数的返回值的类型。如果函数没有返回值可以用void表示。

在js里面调用的时候就会提示：

我们上面写的注释，写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

当然除了变量和函数外，我们还有类（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关键字了。
效果：