By Example

介绍

本指南的目的是教你如何编写高质量的定义文件。本指南的结构是显示某些API的文档，以及该API的示例用法，并解释如何编写相应的声明。

这些示例的排列顺序大约是复杂性的顺序。

• 全局变量

• 全局函数

• 具有属性的对象

• 重载函数

• 可重用类型（接口）

• 可重用类型（类型别名）

• 组织类型

• 类

例子

全局变量

文档

全局变量foo包含存在的小部件的数量。

码

console.log（“小部件数量的一半是”+（foo / 2））;

宣言

使用declare var声明变量。如果变量是只读的，您可以使用declare const。declare let如果变量是块范围，也可以使用。

/** The number of widgets present */
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函数接受一个数字并返回一个Widget，或接受一个字符串并返回一个Widget数组。

代码

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对象。此对象具有以下属性：1 - greeting：必需的字符串2 - duration：可选的时间长度（以毫秒为单位）3 - color：可选字符串，例如'＃ff00ff'

码

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

宣言

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

interface GreetingSettings {
  greeting: string;
  duration?: number;
  color?: string;
}

declare function greet(setting: GreetingSettings): void;

可重用类型（类型别名）

文档

任何地方都可以提供问候，你可以提供string一个函数返回一个string或一个Greeter实例。

代码

function getGreeting() {
  return "howdy";
}
class MyGreeter extends Greeter { }

greet("hello");
greet(getGreeting);
greet(new MyGreeter());

宣言

您可以使用类型别名来简化类型：

type GreetingLike = string | (() => string) | MyGreeter;

declare function greet(g: GreetingLike): void;

组织类型

文档

greeter对象可以登录到文件或显示警报。您可以提供LogOptions .log(...)并将警报选项提供给.alert(...)

代码

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

宣言

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

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

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

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

类

文档

您可以通过实例化Greeter对象来创建迎宾者，或者通过扩展它来创建自定义迎宾者。

代码

const myGreeter = new Greeter("hello, world");
myGreeter.greeting = "howdy";
myGreeter.showGreeting();

class SpecialGreeter extends Greeter {
  constructor() {
    super("Very special greetings");
  }
}

宣言

使用declare class描述一类或类状物体。类可以有属性和方法以及构造函数。

declare class Greeter {
  constructor(greeting: string);

  greeting: string;
  showGreeting(): void;
}