标签导航：

如何为javascript工具库优雅地编写typescript类型定义？

为JavaScript工具库编写优雅的TypeScript类型定义

本文探讨如何为JavaScript工具库编写清晰、准确的TypeScript类型定义文件，特别是index.d.ts文件的编写方法。我们将以名为single-promises的工具库为例，该库包含一个singlepromise函数，该函数将普通函数包装成具有缓存功能的函数，确保只执行一次。其返回值类型既可以是Promise，也可以是非Promise类型，这取决于传入函数的返回值。

编写类型定义的难点在于如何精确描述singlepromise函数的返回值类型。以下TypeScript定义解决了这个问题：

interface SingleOptions {
    cache?: number;
}

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

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

代码定义了两个接口：SingleOptions和SingleFunc，以及singlePromise函数的类型声明。SingleOptions接口定义了可选配置项；SingleFunc接口定义了singlePromise函数返回的函数类型，包含原始函数调用方法、update方法和clear方法。

关键在于SingleFunc接口中的(...args: P): T extends Promise ? T : Promise部分。它使用了条件类型T extends Promise ? T : Promise，巧妙地处理了返回值类型：如果传入函数fn的返回值T是Promise类型，则返回T本身；否则，返回一个Promise包装后的T。 这有效地解决了singlePromise函数返回值类型不确定性问题，从而提供了完整的类型定义，提升了代码的可读性和可维护性。

通过这种方法，我们可以为JavaScript工具库编写出更优雅、更易于维护的TypeScript类型定义，从而提高代码质量和开发效率。