【TypeScript系列】TypeScript 声明文件

举例

这篇指南的目的是教你如何书写高质量的 TypeScript 声明文件。
我们在这里会展示一些 API 的文档，以及它们的使用示例，
并且阐述了如何为它们书写声明文件。

这些例子是按复杂度递增的顺序组织的。

• 带属性的对象
• 函数重载
• 可重用类型（接口）
• 可重用类型（类型别名）
• 组织类型
• 类
• 全局变量
• 全局函数

带属性的对象

文档

全局变量myLib包含一个用于创建祝福的makeGreeting函数，
以及表示祝福数量的numberOfGreetings属性。

代码

let result = myLib.makeGreeting('hello, world');
console.log('The computed greeting is:' + result);

let count = myLib.numberOfGreetings;

声明

使用declare namespace来描述用点表示法访问的类型或值。

declare namespace myLib {
   
   
    function makeGreeting(s: string): string;
    let numberOfGreetings: number;
}

函数重载

文档

getWidget函数接收一个数字参数并返回一个组件；或者接收一个字符串参数并返回一个组件数组。

代码

let x: Widget = getWidget(43);

let arr: Widget[] = getWidget('all of them'<