标签导航:

typescript类型声明:处理promise和非promise返回值的函数

在JavaScript工具库开发中,编写精确的TypeScript类型声明(.d.ts文件)至关重要,它能显著提升开发效率和代码质量。本文将演示如何为一个名为singlepromise的函数编写有效的TypeScript类型声明,该函数对函数调用进行缓存并控制其执行。singlepromise函数接受不同类型参数,并可能返回Promise或非Promise结果。

挑战在于为这个多功能函数编写合适的类型声明。为了解决这个问题,我们将使用泛型和接口。以下代码片段展示了一个完善的index.d.ts文件:

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接口: 定义了singlepromise函数的可选配置项,例如缓存策略。

  • SingleFunc接口: 这是一个泛型接口,P代表参数类型数组,T代表返回值类型。 关键在于T extends Promise ? T : Promise部分。 这利用了条件类型,根据T是否为Promise来决定返回类型:

    • 如果T是Promise,则直接返回T(infer U用于推断Promise的类型,但这里我们不需要用到U)。
    • 如果T不是Promise,则返回Promise,保证始终返回一个Promise。
  • singlePromise函数声明: 这是一个泛型函数,P和T与SingleFunc接口中的泛型对应。 它接受一个函数fn和可选的SingleOptions作为参数,并返回一个SingleFunc

    类型的对象。

通过这种设计,TypeScript编译器可以准确推断singlepromise函数的类型,为开发者提供完整的类型提示和错误检查,从而避免运行时错误。 SingleFunc接口还包含了update和clear方法,用于管理缓存,进一步完善了类型声明。

JavaScript工具库中如何为返回Promise或非Promise结果的函数编写TypeScript类型声明?