如何用TypeScript类型声明完善JavaScript单例Promise函数？-js教程-PHP中文网

如何用TypeScript类型声明完善JavaScript单例Promise函数？

霞舞

发布： 2025-02-27 17:00:26

原创

737人浏览过

TypeScript类型声明完善JavaScript单例Promise函数

本文介绍如何为javascript工具库编写精准的typescript类型声明文件(index.d.ts)，解决类型定义难题。重点在于singlepromise函数的完善类型定义，该函数创建一个单例promise函数，并支持缓存策略更新。

singlepromise函数旨在实现单例模式的Promise函数。开发者需要使用TypeScript类型声明精确描述其行为，包括参数、返回值和可选配置。本文将解决index.d.ts文件中的类型定义问题。

最终的index.d.ts文件类型定义如下：

<code class="typescript">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>;</code>

登录后复制

此代码定义了两个接口：SingleOptions和SingleFunc，以及singlePromise函数的类型声明。SingleOptions接口描述可选配置参数；SingleFunc接口描述singlePromise函数返回的函数类型，包含参数、返回值以及update和clear方法。singlePromise函数的类型声明清晰地指明输入参数和返回类型，并使用条件类型T extends Promise<unknown> ? T : Promise<t></t></unknown>巧妙地处理返回值可能是Promise或非Promise的情况。这使得TypeScript编译器能够准确推断函数类型，提供类型检查和代码提示，有效避免类型错误。