TypeScript 类接口定义

Question

我正在尝试为第三方库创建定义文件 (*.d.ts)。这个库有一个基类，用户对象最终将被继承。但是，该库处理这些对象的构造并将它们自己的内置方法与用户定义的方法合并。所以，我不能只创建用户类implements 的interface，因为用户类没有定义基类的内置方法。

TypeScript 定义d.ts 文件：

module otherlib {
    export interface Base {
        third_party_base_method(): string;
    }
}

用户来源：

// FAILS because MyClass doesn't define third_party_base_method()
class MyClass implements otherlib.Base {
    myfunc() {
        let str = this.third_party_base_method();
    }
}    

我目前拥有的一种解决方法是创建一个 TypeScript 文件 (*.ts)，它定义了一个 class 而不是 interface，其中包含具有空主体或返回虚拟值的基本类型中的所有方法。然后，用户类可以从此 extend 进行类型检查。但是，这看起来真的很hacky，并导致不必要的和潜在危险的原型操作。有没有更好的办法？

TypeScript.ts文件定义第三方库基类：

module otherlib {
    export class Base {
        // Dummy stub definition that is never called
        third_party_base_method(): string { return "dummy"; }
    }
}

用户来源：

class MyClass extends otherlib.Base {
    myfunc() {
        // Proper type checking for calling the method that the
        // third party library adds to the object.
        let str = this.third_party_base_method();
    }
}

更新：

事实上，我确实在使用空存根函数进行扩展时遇到了一些麻烦。所以，我的新解决方法只是创建一个存根以使投射更容易......

TypeScriptd.ts文件定义第三方库基类：

module otherlib {
    export interface Base {
        third_party_base_method(): string;
    }
}

TypeScript .ts 用于转换存根的文件：

module otherlib_stub {
    export class Base {
        get base(): otherlib.Base { return <otherlib.Base><any>this; }
    }
}

用户来源：

class MyClass extends otherlib_stub.Base implements otherlib.Base {
    myfunc() {
        // Proper type checking for calling the method that the
        // third party library adds to the object.
        let str = this.base.third_party_base_method();
    }
}  

Answer 1

您应该使用环境声明。这提供了类型信息，但不会在 JavaScript 输出中生成任何代码：

declare module otherlib {
    export class Base {
        third_party_base_method(): string;
    }
}

你可以把它放在一个扩展名为.d.ts的文件中，以明确它不是一个实现文件。

更新！

这完全取决于第三方库的工作方式，但您可以使用接口将外部成员和本地成员包装成单一类型。

下面的示例假设您调用了一个返回扩展类的方法。如果您需要帮助来制作它的确切版本，您必须提供一个实际工作原理的示例。

declare module otherlib {
    export interface Base {
        third_party_base_method(): string;
    }

    export function externalCodeThatExtendsYourClass<T>(obj: any): T;
}

// You would need the class/interface pair for each class
class Example {
    yourMethod() {
        alert('All yours');
    }
}

// The interface wraps the class members and the externally added members into a single type
interface ExtendedExample extends Example, otherlib.Base { }


var example = otherlib.externalCodeThatExtendsYourClass<ExtendedExample>(new Example());

example.third_party_base_method();
example.yourMethod();