本文整理自网络,侵删。
TypeScript声明文件举例
简介
这篇指南的目的是教你如何书写高质量的TypeScript声明文件。 我们在这里会展示一些API的文档,还有它们的使用示例, 并且阐述了如何为它们书写声明文件。
这些例子是按复杂度递增的顺序组织的。
- 全局变量
- 全局函数
- 带属性的对象
- 函数重载
- 可重用类型(接口)
- 可重用类型(类型别名)
- 组织类型
- 类
例子
全局变量
文档
全局变量foo
包含了存在组件总数。
代码
console.log("Half the number of widgets is " + (foo / 2));
声明
使用declare var
声明变量。 如果变量是只读的,那么可以使用 declare const
。 你还可以使用 declare let
如果变量拥有块级作用域。
/** 组件总数 */
declare var foo: number;
全局函数
文档
用一个字符串参数调用greet
函数向用户显示一条欢迎信息。
代码
greet("hello, world");
声明
使用declare function
声明函数。
declare function greet(greeting: string): void;
带属性的对象
文档
全局变量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");
声明
declare function getWidget(n: number): Widget;
declare function getWidget(s: string): Widget[];
可重用类型(接口)
文档
当指定一个欢迎词时,你必须传入一个GreetingSettings
对象。 这个对象具有以下几个属性:
- greeting:必需的字符串
- duration: 可靠的时长(毫秒表示)
- color: 可选字符串,比如‘#ff00ff’
代码
greet({
greeting: "hello world",
duration: 4000
});
声明
相关阅读 >>
更多相关阅读请进入《typescript》频道 >>

Vue.js 设计与实现 基于Vue.js 3 深入解析Vue.js 设计细节
本书对 Vue.js 3 技术细节的分析非常可靠,对于需要深入理解 Vue.js 3 的用户会有很大的帮助。——尤雨溪,Vue.js作者