返回类型加强取决于是否传递了可选参数

Question

假设我们需要实现一个返回一些东西的方法，但是当这个东西是undefined时，它应该返回一些传入的默认值。但是我们不想将默认值参数设为必需，因此将其声明为可选参数：

private returnSomething(someParam: string, defaultValue?: string) : string | undefined {
    const result: string | undefined = ...; // Some result-producing logic
    return result !== undefined ? result : defaultValue;
}

我们希望以下内容在严格模式下编译（注意 something1: string 类型，它声明时没有 undefined 部分）：

const something1: string = this.returnSomething("someParam1", "?"); // Error, no undefined in the type of something1
const something2: string | undefined = this.returnSomething("someParam2");

是否可以在 TypeScript 中声明一个方法，以便在未传递可选参数时，方法的返回类型被视为 string | undefined，而在传递时，返回类型为 string？

Answer 1

所以，如果我没记错的话，这很容易使用 generic 类型：

const returnSomething = <D extends string | undefined>(someParam: string, defaultValue?: D) : D extends undefined ? string | undefined : string => {

  const result = {} as any;

  return result !== undefined ? result : defaultValue;
}

见playground

UPD 以避免在不使用 any 时出现错误：

const returnSomething = <D extends string | undefined, R extends D extends undefined ? string | undefined : string>(someParam: string, defaultValue?: D) : R => {

  const result = 'str';

  return (result !== undefined ? result : defaultValue) as R;
}

UPD2。正确的方法（我很抱歉搞砸了）。

我想表示歉意，因为我引入了泛型和条件类型，而它们是不必要的。我的意思是，我不知道它们会导致这样的错误。但我也被最初的问题误导了。 所以正常的方式，我会怎么做，看起来像这样：

const returnSomething = (someParam: string, defaultValue?: string): string | undefined => {

    const result = '';

    return result !== undefined ? result : defaultValue;
}

const something1 = returnSomething("someParam1", "?");
const something2 = returnSomething("someParam2");

就是这样。是的，您不应该将类型分配给something1 和something2。相反，您应该运行时检查（并且打字稿从检查中推断类型）：

if (typeof something1 === 'undefined') { 
    /* oops the value is undefined, do something to make the program continue working properly */ 
} 
else {
    something1 // has type "string"
}

关于错误，我已经提交了issue。

Answer 2

Nurbol 已经完成了大部分工作，我必须进行一项额外的更改才能使其充分发挥作用：

const returnSomething = <D extends string | undefined>(someParam: string, defaultValue?: D) : D extends undefined ? string | undefined : string => {
  const result = {} as any;
  return result !== undefined ? result : defaultValue;
}

const something1: string = returnSomething("someParam1", "d"); // No error
const something2: string | undefined = returnSomething("someParam2"); // No error
const something3: string = returnSomething("someParam2"); // Yes error
const something4: string = returnSomething("someParam2", undefined); // Yes error

我们需要先定义D 以接受undefined，否则条件将始终只返回string。

这样做的副作用是您现在可以将undefined 作为默认值传递。但它仍然按预期出错。

你也可以通过函数重载来做到这一点：

function returnSomething(param: string): string | undefined;
function returnSomething(param: string, defaultValue: string): string;
function returnSomething(param: string, defaultValue?: string) {
  const result = {} as any;
  return result !== undefined ? result: defaultValue;
}

这避免了undefined 问题。