使用枚举重载 TypeScript 函数

Question

我在尝试使用 TypeScript 实现函数重载时遇到了一个小问题，其中一个枚举作为参数传递，第二个参数的类型取决于枚举。

例如：

• 如果枚举是FOO，那么第二个参数是string 类型
• 如果枚举是BAR，那么第二个参数是number 类型
• 如果枚举为BAZ，则没有第二个参数

我的代码如下，但不知何故 TypeScript 会抛出错误，因为即使我根据枚举检查第一个参数，intellisense 也不会缩小第二个参数的类型：fieldValue 始终是@987654328 @。

enum ViewName {
    FOO = 'foo',
    BAR = 'bar',
    BAZ = 'baz'
}

function myFunction(viewName: ViewName.FOO, stringValue: string);
function myFunction(viewName: ViewName.BAR, numberValue: number);
function myFunction(viewName: ViewName.BAZ);
function myFunction(viewName: ViewName, fieldValue?: string | number): void {

    if (viewName === ViewName.FOO) {
        fieldValue = fieldValue.reverse();
    }

    if (viewName === ViewName.BAR) {
        fieldValue *= 2;
    }

    if (viewName === ViewName.BAZ) {
        return console.log('No fieldvalue is supplied by BAZ.');
    }

    console.log(fieldValue);
}

代码也可以在TypeScript Playground查看。

Answer 1

Typescript 不会根据第一个参数的类型来缩小第二个参数的类型。这个功能只是没有在 typescript 中实现。

您可以向if 添加额外检查，让编译器缩小fieldValue 的类型

function myFunction(viewName: ViewName.FOO, stringValue: string);
function myFunction(viewName: ViewName.BAR, numberValue: number);
function myFunction(viewName: ViewName.BAZ);
function myFunction(viewName: ViewName, fieldValue?: string | number): void {

    if (viewName === ViewName.FOO && typeof fieldValue === "string") {
        fieldValue = fieldValue.reverse();
    }
    else if (viewName === ViewName.BAR && typeof fieldValue === 'number') {
        fieldValue *= 2;
    }

    console.log(fieldValue);
}

或者你可以只使用类型断言：

function myFunction(viewName: ViewName.FOO, stringValue: string);
function myFunction(viewName: ViewName.BAR, numberValue: number);
function myFunction(viewName: ViewName.BAZ);
function myFunction(viewName: ViewName, fieldValue?: string | number): void {

    if (viewName === ViewName.FOO) {
        fieldValue = (fieldValue as string).reverse();
    }
    else if (viewName === ViewName.BAR) {
        fieldValue =  (fieldValue as number) * 2;
    }

    console.log(fieldValue);
}

更大的变化是使用可区分联合，这将允许编译器以更预期的方式缩小参数的类型：

function myFunction(p: { viewName: ViewName.BAZ }
    | { viewName: ViewName.BAR, fieldValue: number }
    | { viewName: ViewName.FOO, fieldValue: string }): void {

    if (p.viewName === ViewName.FOO) {
        p.fieldValue =  p.fieldValue.reverse();
    }
    else if (p.viewName === ViewName.BAR) {
        p.fieldValue *=  2;
    }

    console.log(fieldValue);
}