TypeScript：文档 - 声明文件参考

本指南旨在教您如何编写高质量的声明文件。指南的结构是展示某些 API 的文档，并附带该 API 的示例用法，同时解释如何编写相应的声明。

这些示例大致按复杂程度递增的顺序排列。

具有属性的对象

文档

全局变量 myLib 拥有一个用于创建问候语的函数 makeGreeting，以及一个表示迄今为止已创建问候语数量的属性 numberOfGreetings。

代码

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

声明

使用 declare namespace 来描述通过点标记法访问的类型或值。

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

函数重载

文档

getWidget 函数接受一个数字并返回一个 Widget，或者接受一个字符串并返回一个 Widget 数组。

代码

ts
let x: Widget = getWidget(43);
let arr: Widget[] = getWidget("all of them");

声明

ts
declare function getWidget(n: number): Widget;
declare function getWidget(s: string): Widget[];

可重用类型（接口）

文档

指定问候语时，必须传递一个 GreetingSettings 对象。该对象具有以下属性：

1 - greeting: 必选字符串

2 - duration: 可选的时间长度（以毫秒为单位）

3 - color: 可选字符串，例如 ‘#ff00ff’

代码

ts
greet({
  greeting: "hello world",
  duration: 4000
});

声明

使用 interface 定义具有属性的类型。

ts
interface GreetingSettings {
  greeting: string;
  duration?: number;
  color?: string;
}
declare function greet(setting: GreetingSettings): void;

可重用类型（类型别名）

文档

在任何期望得到问候语的地方，您都可以提供一个 string、一个返回 string 的函数或一个 Greeter 实例。

代码

ts
function getGreeting() {
  return "howdy";
}
class MyGreeter extends Greeter {}
greet("hello");
greet(getGreeting);
greet(new MyGreeter());

声明

您可以使用类型别名为类型创建简写形式。

ts
type GreetingLike = string | (() => string) | MyGreeter;
declare function greet(g: GreetingLike): void;

组织类型

文档

greeter 对象可以记录到文件或显示警告。您可以向 .log(...) 提供 LogOptions，向 .alert(...) 提供警告选项。

代码

ts
const g = new Greeter("Hello");
g.log({ verbose: true });
g.alert({ modal: false, title: "Current Greeting" });

声明

使用命名空间来组织类型。

ts
declare namespace GreetingLib {
  interface LogOptions {
    verbose?: boolean;
  }
  interface AlertOptions {
    modal: boolean;
    title?: string;
    color?: string;
  }
}

您也可以在一个声明中创建嵌套的命名空间。

ts
declare namespace GreetingLib.Options {
  // Refer to via GreetingLib.Options.Log
  interface Log {
    verbose?: boolean;
  }
  interface Alert {
    modal: boolean;
    title?: string;
    color?: string;
  }
}

类 (Classes)

文档

您可以通过实例化 Greeter 对象来创建一个 greeter，或者通过继承它来创建一个自定义的 greeter。

代码

ts
const myGreeter = new Greeter("hello, world");
myGreeter.greeting = "howdy";
myGreeter.showGreeting();
class SpecialGreeter extends Greeter {
  constructor() {
    super("Very special greetings");
  }
}

声明

使用 declare class 来描述类或类对象。类可以拥有属性和方法，也可以拥有构造函数。

ts
declare class Greeter {
  constructor(greeting: string);
  greeting: string;
  showGreeting(): void;
}

全局变量

文档

全局变量 foo 包含了当前存在的窗口小部件（widgets）数量。

代码

ts
console.log("Half the number of widgets is " + foo / 2);

声明

使用 declare var 来声明变量。如果变量是只读的，可以使用 declare const。如果变量是块级作用域的，也可以使用 declare let。

ts
/** The number of widgets present */
declare var foo: number;

全局函数

文档

您可以使用字符串调用 greet 函数，向用户显示问候语。

代码

ts
greet("hello, world");

声明

使用 declare function 来声明函数。

ts
declare function greet(greeting: string): void;

声明参考