如何在TypeScript中扩展Actions on Google v2 Node.js客户端的conv实例

在TypeScript里直接给conv添加自定义属性时，TypeScript编译器会因为原接口没有定义这个属性而报错——毕竟TS就是靠类型检查来规避潜在问题的。不用any强制转换的话，最佳方案是扩展原有的TypeScript接口，下面是具体实现步骤：

1. 通过模块扩展添加自定义属性 #

Actions on Google的TypeScript类型定义基于接口实现，我们可以利用TypeScript的「模块扩展」特性，给DialogflowConversation接口补充自定义属性。

完整代码示例：

import { dialogflow, DialogflowConversation } from 'actions-on-google';

// 定义你的Helper工具类
class Helper {
  constructor(public conv: DialogflowConversation) {}

  func1() {
    this.conv.ask(`What's up?`);
  }
}

// 扩展DialogflowConversation接口，新增helper属性
declare module 'actions-on-google' {
  interface DialogflowConversation {
    helper: Helper;
  }
}

// 初始化app并绑定middleware
const app = dialogflow()
  .middleware(conv => {
    conv.helper = new Helper(conv); // 此处不再触发类型报错
  });

// 在Intent中正常使用
app.intent('Default Welcome Intent', conv => {
  conv.helper.func1(); // TypeScript类型检查完全通过，还能获得代码提示
});

2. 方案优势说明 #

• 完全保留TypeScript的类型校验能力，避免了any带来的类型安全隐患
• 扩展后的接口全局生效，所有用到DialogflowConversation的地方都能识别helper属性
• 代码风格符合TypeScript最佳实践，可读性和维护性更强

3. 注意事项 #

• 如果把接口扩展代码放在单独的.d.ts文件中，需要确保该文件被tsconfig.json的include数组覆盖，示例配置：

  {
    "include": [
      "src/**/*",
      "src/custom-types/actions-on-google.d.ts"
    ]
  }
  

• 如果是在业务代码文件内直接写扩展，无需单独创建.d.ts文件，直接写declare module即可。

内容的提问来源于stack exchange，提问作者Markus