标签导航：

javascript工具库类型声明：如何正确编写single-promises的index.d.ts？

深入探讨 JavaScript 工具库类型声明：single-promises 的 index.d.ts

编写精准的 TypeScript 类型声明文件 (.d.ts) 对 JavaScript 工具库至关重要，它能显著提升代码质量，并为使用 TypeScript 的开发者提供更友好的开发体验。本文将详细分析 single-promises 工具库的 index.d.ts 文件编写，该工具库的核心功能是创建一个单例函数，确保在指定时间内仅执行一次。

问题与解决方案

single-promises 工具库需要一个完善的类型定义，以便 TypeScript 开发者正确使用。 关键在于准确描述 singlePromise 函数的类型和返回值，这取决于传入函数 fn 的返回值类型（Promise 或同步值）。

以下是一个有效的 index.d.ts 实现：

interface SingleOptions {
    cache?: number;
}

interface SingleFunc<P extends unknown[], T> {
    (...args: P): T extends Promise<infer U> ? T : Promise<T>;
    update(opt?: SingleOptions): void;
    clear(): void;
}

export function singlePromise<P extends unknown[], T>(
    fn: (...args: P) => T,
    opt?: SingleOptions
): SingleFunc<P, T>;

代码详解

  • SingleOptions 接口: 定义了 singlePromise 函数的可选配置，包含 cache 属性（缓存时间）。

  • SingleFunc 接口: 描述了 singlePromise 函数返回的函数类型。

    • (...args: P): T extends Promise ? T : Promise; 这是核心部分，使用了条件类型。它根据 fn 函数的返回值 T 是否为 Promise 进行类型推断。

      • 如果 T 是 Promise，则返回类型为 T 本身。
      • 如果 T 不是 Promise，则返回类型为 Promise。 infer U 用于提取 Promise 的类型参数，但这里并不直接使用，因为我们只需要知道是否是 Promise 就够了。

    • update(opt?: SingleOptions): void; 更新配置。

    • clear(): void; 清除缓存。

  • singlePromise 函数声明: 声明了 singlePromise 函数的类型签名。 泛型 P 代表传入函数的参数类型数组，T 代表传入函数的返回值类型。 返回值类型是 SingleFunc

    ，确保类型安全。

通过这个 index.d.ts 文件，TypeScript 编译器能够准确推断 singlePromise 函数的返回值类型，从而避免类型错误，并提供更准确的代码提示和自动补全功能。 这使得开发者能够更轻松、更安全地使用 single-promises 工具库。