打字稿：确保对象文字扩展接口但返回真实对象类型

Question

我正在尝试在 typescript 中创建一个函数，该函数返回一个必须扩展给定接口的对象，但我希望该函数返回所创建对象的真实类型。 原因是函数中的对象将来可能会发生变化，我想确保它始终具有界面所需的最少道具。

示例：

interface MustExtend {
  a: string;
}

function myFunc() {
  // I want to enforce res to extend type MustExtend
  // right now it can be of type {something: 3} and compiler will allow it
  const res = {a: 'hello', b: 2} 
  return res;
}

const c = myFunc(); // c should be of type {a: string, b: number}, or the more concrete type generated by method

编辑：

我会尽量澄清我的问题。我希望从返回的对象中推断出函数的结果类型，而不指定 res 的类型，因为它是由许多计算生成的：

interface MustExtend {
  a: string;
}

function myFunc() {
  // i want to enforce res to extend type MustExtend
  // right now it can be of type {something: 3} (no 'a' at all)
  // and i want to make sure it exists
  const res = {
    a: 'hello', 
    b: 2, 
    // a million more properties here that can change over time
  } 
  return res;
}

const c = myFunc(); // c should be of type {a: string, b: number, ...other props}

Answer 1

你可以使用一个技巧。 强制 Typescript 将 res 转换为 MustExtend，但随后您将其转换回以保留原始类型：

interface MustExtend {
  a: string;
}

function myFunc() {
  const res  = {
    a: 'hello', // will cause TS error if you remove this line
    b: 2,
    1: '1',
  } 

  return res as MustExtend as typeof res; // convert and convert back
}

const c = myFunc(); // will have full type

Answer 2

经过一番修改，我找到了方法：

interface MustExtend {
  a: string;
}

function myFunc(): typeof res extends MustExtend ? typeof res : never {
  // i want to enforce res to extend type MustExtend
  // right now it can be of type {something: 3} (no 'a' at all)
  // and i want to make sure it exists
  const res = {
    a: 'hello', 
    b: 2, 
    // a million more properties here that can change over time
  } 
  return res;
}

const c = myFunc(); // c should be of type {a: string, b: number, ...other props}

显然打字稿可以在编译时获取方法中对象的类型并在方法类型中使用它。以这种方式使用它我不必提前指定res 的类型，并确保它具有接口中的所有属性

Answer 3

函数返回类型定义可以是类类型，也可以是接口。如果您要定义这样的函数：

function myFunc(): MustExtend {}

其中MustExtend是一个接口，它将返回符合接口MustExtend的对象。但是返回的对象仍然有它的类型，可以用instanceof检查。实际上，在打字稿中，您无法检查返回的对象是否符合您想要的接口 - instanceof 不适用于接口。所以你必须检查对象的实际类型。使用此定义，您可以返回符合MustExtend（可怕的名称，名词上的名称接口：）的任何对象，然后您可以检查（如果需要）它的确切类型。希望对您有所帮助。

Answer 4

您的函数已经返回了可能的最通用类型。当您使用返回值时，强制此类型与接口匹配。例如，您可以进行这样的检查：

const check: () => MustExtend = () => myFunc()
// or
const check1: MustExtend | undefined = undefined as ReturnType<typeof myFunc> | undefined;

Playground

据我所知，如果您只需要在类型级别强制执行测试（不生成 javascript 对象），您需要一个外部工具，例如 dtslint.

Answer 5

interface MustExtend {
  a: string;
}

const c = {
  a: 'hello',
  b: 2,
}
// Ensure `c` conforms to MustExtend. (`c` will continue to have its original type)
c as MustExtend // Works!

const d = {
  x: 1,
  y: 2,
}
// Ensure `d` conforms to MustExtend
d as MustExtend // Error! Property 'a' is missing

playground