TypeScript 定义风格指南最佳实践

1. 项目介绍

TypeScript 定义风格指南项目（typescript-definition-style-guide）是由 sindresorhus 创建和维护的，旨在为 TypeScript 用户在为 npm 包添加类型定义时提供一套最佳实践。该项目通过一系列规则和建议，帮助开发者创建清晰、一致且符合 TypeScript 标准的类型定义。

2. 项目快速启动

在开始之前，确保你的环境中已安装了 Node.js 和 TypeScript。

克隆项目

git clone https://github.com/sindresorhus/typescript-definition-style-guide.git
cd typescript-definition-style-guide

安装依赖

npm install

编译项目

npm run build

运行测试

npm test

3. 应用案例和最佳实践

以下是一些根据 TypeScript 定义风格指南的最佳实践案例：

类型定义文件结构

// index.d.ts
export interface Options {
  /**
   * 允许负数。
   * @default true
   */
  allowNegative?: boolean;
  /**
   * 是否拥有超级功能。
   * @default false
   */
  hasFoo?: boolean;
  /**
   * 保存位置。
   * 默认: [用户的下载目录](https://example.com)
   */
  saveDirectory?: string;
}

/**
 * 将两个数字相加。
 * @param x - 第一个要相加的数字。
 * @param y - 第二个要相加的数字。
 * @returns x 和 y 的和。
 */
export default function add(x: number, y: number, options?: Options): number;

文档注释

确保导出的定义包含 TSDoc 注释，以提供类型和参数的详细信息。

/**
 * Options 类型定义。
 */
export interface Options {
  // ...
}

类型测试

使用 tsd 库来测试你的类型定义。

// test/index.test-d.ts
import { expectType } from 'tsd';
import { add } from './index';

expectType<number>(add(1, 2));
expectType<number>(add(1, 2, { allowNegative: false }));

4. 典型生态项目

TypeScript 生态中，许多项目遵循了类似的定义风格，以下是一些典型的例子：

• @types/node: Node.js 的官方 TypeScript 类型定义。
• react: React 的类型定义和类型支持。
• vue: Vue.js 的类型定义。

这些项目都展示了如何利用 TypeScript 定义风格指南来创建一致和可维护的类型定义。