打字稿：返回与参数相同类型的通用函数

Question

考虑一下（不编译）：

function roundTo<T = number | null | undefined>(
  num: T,
  decimals: number,
): T {
  if (num === null || num === undefined) return num;

  const factor = Math.pow(10, decimals);
  return (Math.round(num * factor) / factor);
}

我想将传递给roundto（）函数的相同类型返回。

例如：

const num1: number | null = 1.123456;
roundTo(num1, 1) // return type number | null

const num2: number = 1.123456;
roundTo(num2, 1) // return type number

const num3 = null;
roundTo(num3, 1) // return type null

roughto的返回类型是在编译时已知的，因此希望能够根据第一个参数中传递的类型从那里转移类型。

我可以通过将返回类型施放为任何来进行编译，但这会破坏类型的安全性。我还可以通过使用扩展而不是=并将返回类型作为t 进行编译，但是它具有返回<< 代码>任何当null或未定义被传递时。

如何获得打字稿以展示所需的行为？

有关的： https://stackoverflow.com/a/a/51195834/188740 https://stackoverflow.com/a/a/57529925/188740

Answer 1

它应该是t扩展...，而不是t = ...。后一种形式是“ t的默认值”，它不是被推断出来的，而是总是被称为声明的，基本上杀死了整个想法。

  function roundTo<T extends number | null | undefined>(num: T, decimals: number): T {
    if (num == null) return num;
    const factor = Math.pow(10, decimals);
    return (Math.round((num as number) * factor) / factor) as T;
  }

  function test(x: number, y: null, z: undefined, t?: number, u?: null) {
    let x1 = roundTo(x, 2); // -> number
    let x2 = roundTo(y, 2); // -> null
    let x3 = roundTo(z, 2); // -> undefined
    let x4 = roundTo(t, 2); // -> number | undefined
    let x5 = roundTo(u, 2); // -> null | undefined
  }

实际上，您可以摆脱一种类型的coersion num为号码，但

  function roundTo<T extends number | null | undefined>(num: T, decimals: number): T {
    if (typeof num === 'number') {
      // here typescript knows, that num is specific subtype of T - number
      // but doesn't extend this to the T itself
      const factor = Math.pow(10, decimals);
      return Math.round(num * factor) / factor as T;
    }
    return num;
  }

如果您真正地想强制推断实际类型在功能内部的t，可能是有条件的键入方式，但恕我直言，这是过度的。

@johnny oshika的另一点 - 可以避免使用不必要的数字类型的狭窄，可以使用：

  function roundTo(num: number, decimals: number): number;
  function roundTo<T extends number | null | undefined>(num: T, decimals: number): T;
  function roundTo<T extends number | null | undefined>(num: T, decimals: number): T {
   // function body
  }

Answer 2

此答案归功于@jcalz。

使用过载签名设置有条件的返回类型的t扩展数字？编号：t。然后，实现可以放松类型推理。

// Overload signature
export function roundTo<T extends number | null | undefined>(
  num: T,
  decimals: number,
): T extends number ? number : T;

// Implementation
export function roundTo(
  num: number | null | undefined,
  decimals: number,
) {
  if (num === null || num === undefined) return num;
  const factor = Math.pow(10, decimals);
  return Math.round(num * factor) / factor;
}

示例：

roundTo(undefined, 2) // Returns type `undefined`
roundTo(null, 2) // Returns type `null`
roundTo(1.234 as number | undefined, 2) // Returns type `number | undefined`
roundTo(1.234 as number | null, 2) // Returns type `number | null`
roundTo(1.234, 2) // Returns type `number`