当前位置：首页 > 文章列表 > 文章 > 前端 > JS工具库singlePromise函数类型声明详解及实战

JS工具库singlePromise函数类型声明详解及实战

2025-03-07 23:57:21 0浏览收藏

本文旨在指导开发者为JavaScript工具库中的`singlePromise`函数编写正确的TypeScript类型声明文件(`index.d.ts`)。`singlePromise`函数采用单例模式，其返回值类型取决于传入函数的返回值是否为Promise对象。文章详细讲解了`SingleOptions`和`SingleFunc`接口的定义，以及`singlePromise`函数声明中关键的条件类型(`T extends Promise ? T : Promise`)的使用，最终实现精准的类型检查和代码提示，提升开发效率和代码可维护性。通过学习本文，您可以轻松编写出高质量的TypeScript类型声明文件，确保代码的健壮性和可读性。

如何为JavaScript工具库中的singlePromise函数编写正确的index.d.ts类型声明？

JavaScript工具库类型声明文件index.d.ts编写详解

编写正确的TypeScript类型声明文件(.d.ts)对于JavaScript工具库至关重要，它能显著提升代码质量和开发体验。本文将详细阐述如何为一个名为singlePromise的函数编写index.d.ts文件。该函数实现单例模式，并根据返回值类型决定是否返回Promise对象。

singlePromise函数的目标是将传入的函数单例化，根据其返回值类型（是否为Promise）调整输出类型。为了在TypeScript中正确定义其类型，我们需要编写如下index.d.ts文件：

interface SingleOptions {
    cache?: number;
}

interface SingleFunc {
    (...args: P): T extends Promise ? T : Promise;
    update(opt?: SingleOptions): void;
    clear(): void;
}

export function singlePromise
(
    fn: (...args: P) => T,
    opt?: SingleOptions
): SingleFunc
;

代码解释：

SingleOptions 接口: 定义了singlePromise函数的可选配置参数，cache属性用于指定缓存策略。
SingleFunc 接口: 定义了singlePromise函数返回的函数类型。
- P extends any[]: 泛型P表示传入函数的参数类型，any[]确保可以接受任何类型的参数数组。
- T: 泛型T表示传入函数的返回值类型。
- (...args: P): T extends Promise ? T : Promise; 这是关键部分，利用条件类型判断T是否为Promise。如果是，则返回T本身；如果不是，则返回Promise。infer U 用于提取Promise的类型参数，但这里我们并不需要使用它，所以直接使用T即可。
singlePromise 函数声明: 清晰地定义了singlePromise函数的参数和返回值类型。 P extends any[], T 确保泛型类型推断正确。