如何在定义为“any”的第三方TypeScript接口中扩充属性?

时间:2018-02-08 16:44:54

标签: typescript module interface

给定第三方TypeScript模块,如下所示:

// in /node_modules/third-party-module/index.d.ts
declare module 'ThirdPartyModule' {
    export interface ThirdPartyInterface {
        data: any;
    }
}

如何扩充此模块以更严格地键入data属性?

我试过这个:

// in /app/typings.d.ts
declare module 'ThirdPartyModule' {

    interface IMyCustomType {}

    interface ThirdPartyInterface {

        // causes a compiler error: Subsequent property declarations 
        // must have the same type.  Property 'data' must be of type 
        // 'any', but here has type 'IMyCustomType'.
        data: IMyCustomType;
    }
}

但是这给了我一个编译器错误:“后续属性声明必须具有相同的类型。属性'data'必须是'any'类型,但这里有类型'IMyCustomType'。”

如果第三方模块将该属性定义为实际类型,如下所示:

// in /node_modules/third-party-module/index.d.ts
declare module 'ThirdPartyModule' {
    interface IAnotherThirdPartyInterface {
        something: string;
    }

    interface ThirdPartyInterface {
        data: IAnotherThirdPartyInterface;
    }
}

我可以简单地让我的IMyCustomType接口扩展此第三方类型:

// in /app/typings.d.ts
declare module 'ThirdPartyModule' {
    interface IMyCustomType extends IAnotherThirdPartyInterface {}

    interface ThirdPartyInterface {
        data: IMyCustomType;
    }
}

但是,由于类型定义为any,我无法扩展它:

// causes a compiler error:  'any' only refers to a type, 
// but is being used as a value here.
interface IMyCustomType extends any {}

1 个答案:

答案 0 :(得分:3)

虽然您无法重新定义属性,但另一种方法是定义新属性,并使用此新属性扩充原始对象。虽然这种解决方案通常不适用,但如果属性在一个类中,则可以完成。在您的情况下,您在评论hapi中提及。由于该属性位于Server类,因此我们可以定义属性的新类型版本。

<强> hapi.augment.ts

import *  as Hapi from 'hapi'

declare module 'hapi' {
    export function server(cfg: any): Hapi.Server;
    interface Server {
        typedApp:  {
            myData: string
        }
    }
}

Object.defineProperty(Hapi.Server.prototype, 'typedApp', {
    enumerable: false,
    get(this: Hapi.Server){
        return this.app;
    },
    set(this: Hapi.Server, value: any){
        this.app = value;
    }
});

<强> usage.ts

import *  as Hapi from 'hapi'
import './hapi.augment'

const server = new Hapi.Server()
server.connection({ port: 3000, host: 'localhost' });
server.start();
server.typedApp.myData = "Here";

server.route({
    method: 'GET',
    path: '/',
    handler: function (request, reply) {
        reply(request.server.typedApp.myData);
    }
});