Typescript 接口的额外属性作为同一接口的方法的参数类型'

发布于03月22日

我正在try 引入一个API，在该API中传递对象，对象的方法将有this个类型作为对象本身，而不显式地指定对象的类型.

我试过这个:

interface BaseProcessor<T> {
    process(this: Readonly<T>): void;
    [key: string | symbol]: unknown;
}

function makeProcessor<T extends BaseProcessor<T>>(definition: T) {
    // code...
}

export const processor = makeProcessor({
    hello: "world!",
    // other possible properties of different types...
    
    process() {
        console.log(this.hello); // <--- this.hello is of type "unknown"
    }
});

(Typescript Playground link)

我想要实现的是有this.hello个类型是string.类似地，添加到对象中的其他属性将在this上键入它们的值，但稍微更改类型(例如，使它们像提供的示例中一样).

有可能做到吗？任何帮助或建议，感谢.

推荐答案

由于您希望process()方法中infer this的编译器为Readonly<T>，因此使用magical/intrinsic ThisType<T> utility type作为标记上下文this类型的一种方式将有更大的成功机会.那么你不需要BaseProcessor岁就是generic岁:

interface BaseProcessor {
    process(): void;
    [key: string | symbol]: unknown;
}

你只需要makeProcessor()就可以正确地勾住ThisType:

function makeProcessor<T extends BaseProcessor>(
    definition: T & ThisType<Readonly<T>>
) {
    // code...
}

现在，您得到了预期的行为:

const processor = makeProcessor({
    hello: "world!",

    process() {
        this;
        // ^? this: Readonly<{ hello: string; process(): void; }>
        console.log(this.hello);
    }
});

Playground link to code个