如何创建高质量的TypeScript声明文件(六) - 示例

发表于 分类于 阅读次数：

继续上篇文章【如何创建高质量的TypeScript声明文件(五) - 示例】 上篇文章介绍了

  • 全局变量
  • 全局函数
  • 具有属性的对象
  • 重载函数
  • 可重用类型（接口）

几种示例

下面继续分享剩余的几种示例

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

可重用类型（类型别名）

文档

在需要问候语的任何地方，您可以提供字符串，返回字符串的函数或Greeter实例。

代码

1
2
3
4
5
6
7
8
function getGreeting() {
    return "howdy";
}
class MyGreeter extends Greeter { }

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

声明

您可以使用类型别名来为类型创建简写：

1
2
3
type GreetingLike = string | (() => string) | MyGreeter;

declare function greet(g: GreetingLike): void;

组织类型

文档

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

代码

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

声明

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

1
2
3
4
5
6
7
8
9
10
declare namespace GreetingLib {
    interface LogOptions {
        verbose?: boolean;
    }
    interface AlertOptions {
        modal: boolean;
        title?: string;
        color?: string;
    }
}

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

1
2
3
4
5
6
7
8
9
10
11
declare namespace GreetingLib.Options {
    // Refer to via GreetingLib.Options.Log
    interface Log {
        verbose?: boolean;
    }
    interface Alert {
        modal: boolean;
        title?: string;
        color?: string;
    }
}

具有属性的对象

文档

您可以通过实例化Greeter对象来创建一个greeter，或者通过从中扩展来创建一个自定义的greeter。

代码

1
2
3
4
5
6
7
8
9
const myGreeter = new Greeter("hello, world");
myGreeter.greeting = "howdy";
myGreeter.showGreeting();

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

声明

使用declare类来描述类或类类对象。 类可以具有属性和方法以及构造函数。

1
2
3
4
5
6
declare class Greeter {
    constructor(greeting: string);

    greeting: string;
    showGreeting(): void;
}