在Typescript中为Koa2的上下文添加属性

Question

我想在Typescript中使用Facebook的DataLoader和Koa2.我希望每个请求的DataLoader实例与我的每个请求数据库连接一起使用.如何最好地实现这一目标？

我目前的方法是增加Koa2上下文,但我失败了,因为我不知道如何修复类型定义.

这是我对模块增强的尝试......

import 'koa';

declare module 'koa' {
    namespace Application {
        interface BaseContext {
            dataLoader(): any;
        }
    }
}

Application.BaseContext.prototype.dataLoader = function() {
    console.log("Cannot find name 'Application' at line 11 col 1");
}

除了日志调用中显示的错误之外,我还会Property 'dataLoader' does not exist on type 'BaseContext'在导入上述内容并尝试调用时获取dataLoader.

干杯

Answer 1

刚刚想出了一种不需要任何类型黑客的方法：

interface ICustomAppContext {
  mySlowToInitializeClient: string;
}

interface ICustomAppState {
  poop: string;
}

const app = new Koa<ICustomAppState, ICustomAppContext>();

有关详细信息，请参阅https://github.com/DefinitelyTyped/DefinitelyTyped/blob/b081a5b7d0db7181901d7834f8a85206af263094/types/koa/index.d.ts#L434。

Answer 2

好吧，我想我还有很多东西要学。打字问题的解决方案似乎是......

import { BaseContext } from 'koa';

declare module 'koa' {
  interface BaseContext {
    dataLoader(): any;
  }
}

而且，因为BaseContext是一个接口而不是一个类，所以你必须dataLoader在实例化 Koa 的Application类之后定义实现。

const app = new Application();

app.context.dataLoader = function() {
  console.log('OK, this works.');
}

app.context 是用于创建每个请求的上下文对象的原型。

如果您对此答案的正确性提出任何意见，我将不胜感激。谢谢。

啊……在公共场合学习。

Answer 3

看一下Module Augmentation,了解更多如何工作.

你确实可以这样做:

import { Context } from "koa";

declare module "koa" {
    /**
     * See https://www.typescriptlang.org/docs/handbook/declaration-merging.html for
     * more on declaration merging
     */
    interface Context {
        myProperty: string;
        myOtherProperty: number;
    }
}