typescript - 如果函数可以抛出异常，应该返回包含 "never"

Question

如果我有一个函数，在正常情况下返回一个值，但可以抛出异常，原型(prototype)应该是什么样的？它应该包括 |从不(例如，其正常返回类型和 never 的联合)？

例如，是否有理由做以下事情？如果不出意外，它似乎可能会向 future 的编码人员指出可能的异常(exception)情况。

function fn( n: number ) : number | never {
    if ( n < 0 ) throw ("badness");
    return n;
}

Answer 1

这并没有什么坏处，但是这样做没有多大意义。 never 充当 bottom type没有可能的值，并且积极地 removed from unions由编译器:

Because never is a subtype of every type, it is always omitted from union types and it is ignored in function return type inference as long as there are other types being returned.

这意味着如果你用类似 IntelliSense 的东西检查你的函数，它将显示为:

function fn(n: number): number

因此 future 的编码人员甚至不太可能注意到差异。在实践中，没有区别，因为很难保证在某些函数中不会 抛出异常。

---

一种更安全但更烦人的方法是在不依赖异常的情况下在返回类型中编码可能的失败，例如:

function fn( n: number ) : number | undefined {
    if ( n < 0 ) return undefined;
    return n;
}

或更详细但非常明确的意图:

type Success<T> = { success: true, value: T };
type Error<E> = { success: false, error: E };
function fn(n: number): Success<number> | Error<string> {
  if (n < 0) return { success: false, error: "badness" };
  return { success: true, value: n };
}

这实际上取决于您的用例。

---

可能我只是保留原样并使用 JSDoc注释以提示可能的异常(exception)情况。

/** Returns n if n is non-negative, throws an exception otherwise */
function fn(n: number): number | never {
  if (n < 0) throw ("badness");
  return n;
}

如果您使用带有 IntelliSense 的编辑器, 提示会出现:

希望对您有所帮助。祝你好运!