打字稿：使用模块扩充在内部对象上添加属性答案

【问题标题】：Typescript: Add a property on an inner object with module augmentation打字稿：使用模块扩充在内部对象上添加属性
【发布时间】：2020-08-26 04:31:39
【问题描述】：

考虑一个外部 (npm) 模块 extmod 在其声明文件中公开以下接口：

interface Options {
  somevar?: string;
  suboptions?: {
    somesubvar?: string;
  };
}

如何通过模块扩充在suboptions 中添加属性somesubvar2？

我在 extmod.d.ts 文件中尝试了以下内容：

declare module 'extmod' {
  interface Options {
    suboptions?: {
      somesubvar2?: string;
    };
  }
}

但它会引发以下错误：

error TS2687: All declarations of 'suboptions' must have identical modifiers.

error TS2717: Subsequent property declarations must have the same type.  Property 'suboptions' must be of type '<SNIP>', but here has type '{ somesubvar2: string; }'.

【问题讨论】：

您可能想看看indexable types 或简单地使用多个接口。我认为你不能“嵌套”它们。
你不能像这样合并字段...见Module declaration with same name for property and function;这能回答你的问题吗？
也许我错了，have a look
或How can I augment a property within a third-party TypeScript interface defined as “any”?
您是否使用带有声明文件的第三方库？如果是这样，您可能需要在本地复制它，随意修改它，然后使用修改后的版本。至于“所述接口用于库本身定义的多个函数的参数中”......但somesubvar2是suboptions的必需属性不会有问题？

标签： typescript module-augmentation

【解决方案1】：

这本可以做得更好，使用环境声明在全球范围内可用，但它仍然可以完成工作。

import Web3 from 'web3'
import type { Contract as TheBadContract } from 'xyz'

interface ContractMethods {
  // some properties...
}

interface Contract extends Modify<TheBadContract, {
  methods: ContractMethods // <- this `methods` is the actual overwritten property
}> {}

const contract: Contract = new web3.eth.Contract()

这很简单，因为 methods 对象是直接成员，它是原始 Contract 类型上的 undefined。

如果您需要实际修改一些深度嵌套的键，请查看下面我的ModifyDeep 类型。

Modify:https://stackoverflow.com/a/55032655/985454
ModifyDeep:https://stackoverflow.com/a/65561287/985454

【讨论】：

【解决方案2】：

如何在带有模块的子选项中添加属性 somesubvar2 增强？

在您的示例中，您将类型 suboptions 从 <SNIP> 更改为 { somesubvar2: string; }

您可以使用附加属性修补 <SNIP> 类型。

【讨论】：