标签导航：

如何为javascript工具函数singlepromise编写正确的typescript声明文件？

TypeScript类型声明文件提升JavaScript工具库可用性

为JavaScript工具库编写TypeScript声明文件（.d.ts）, 能显著提升其在TypeScript项目中的可用性，提供类型检查和代码提示等优势。本文以名为singlePromise的JavaScript工具函数为例，讲解如何编写正确的index.d.ts声明文件。

singlePromise函数的功能是将任意函数包装成单例模式，确保其在指定时间内只执行一次。为了让TypeScript正确识别和使用该函数，我们需要创建一个index.d.ts文件声明其类型。

以下是一个完整的类型声明示例：

interface SingleOptions {
    cache?: number;
}

interface SingleFunc<P extends unknown[], T> {
    (...args: P): T extends Promise<unknown> ? 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和SingleFunc。SingleOptions接口描述了singlePromise函数的可选配置参数，cache属性表示缓存时间。SingleFunc接口描述了singlePromise函数的返回值类型，它是一个函数，接收任意参数P，返回类型T。

关键在于返回值类型使用了条件类型T extends Promise ? T : Promise。这意味着如果函数fn返回一个Promise，则singlePromise返回的函数也返回该Promise；否则，singlePromise返回一个Promise，其结果为fn的执行结果。

SingleFunc接口还定义了update和clear方法，分别用于更新配置和清除缓存。

最后，export function singlePromise声明了singlePromise函数的类型签名，清晰地定义了参数和返回值类型。有了这个声明，TypeScript编译器就能在使用singlePromise函数时进行类型检查，并提供代码提示，从而提高开发效率和代码质量。