带有类型或接口的 TypeScript 解构默认参数

Sar*_*yan 3 types interface destructuring optional typescript

我正在编写一个函数,它接受一个可选对象options,它本身包含一个可选属性params。此options对象具有默认值,{}因此可以在函数签名中正确解构。

但是,我在尝试使用接口输入时遇到问题:

type Params = {
  params?: { [key: string]: boolean }
}

interface Foo {
  (options?: Params): void
};

const myFoo: Foo = ({ params } = {}) => {} // Property 'params' does not exist on type 'Params | undefined'.
Run Code Online (Sandbox Code Playgroud)

该错误是有道理的:据编译器所知,options可能是未定义的(当参数设置为optional时由它解释),因此params可能不存在。

但是,它没有考虑可选参数可能具有默认值。然而,我还没有找到一种在类型或接口中正确指示这一点的方法。直接在函数签名中键入确实有效,但这不能重用或导出。

在使用类型或接口时,是否有任何标准方法可以解决这个问题?

Pat*_*rts 6

对于该类型推断options参数的参数列表中通过myFoo: FooParams | undefined,无论默认值是否在实现提供。由于默认值myFoo,它仅在主体中推断optionsParams

// hover over options here: Params | undefined
const myFoo: Foo = (options = {}) => {
  // hover over options here: Params
  options;
};
Run Code Online (Sandbox Code Playgroud)

要修复它,请推迟对象解构,直到options从实现的默认值完全推断出for 的类型:

// no error
const myFoo: Foo = (options = {}) => {
  const { params } = options;
};
Run Code Online (Sandbox Code Playgroud)

或者正如您已经发现的那样,您可以通过将参数显式键入为 来帮助类型推断Params。但是,在某些情况下,这会带来误导编译器的潜在风险:

// no error
const myFoo: Foo = ({ params }: Params = {}) => {};
Run Code Online (Sandbox Code Playgroud)