类模块的声明文件（TypeScript）

Question

I use a node module that's not found by typings and doesn't exist in definelytyped.

the basic use of the module is:

import * as SomeClass from 'some-module';

var someObject = new SomeClass("some string");
someObject.someMethod();

As you can see, this module exports a class as its default. I haven't figured out how to write the declaration file for it.

This is the best I managed to do:

declare module 'some-module' {
    export default class SomeClass {
        constructor (someArg: string);
        someMethod(): void;
    }
}

BTW it does work JavaScriptly. It's only the TypeScript bothers me.

Any ideas how to solve that?

Answer 1

For the declaration, you need to do this:

declare module 'some-module' {
    class SomeClass {
        constructor (someArg: string);
        someMethod(): void;
    }
    namespace SomeClass {}
    export = SomeClass;
}

UPDATE: Thank you to Blake Embrey for pointing out, the hack namespace SomeClass {} is needed to get this working. see https://github.com/Microsoft/TypeScript/issues/5073 for more detail.

Answer 2

如果您只是想避免TypeScript错误并且不担心ItelliSense，只需像在文件开头那样声明类库即可，例如：

declare var SomeClass: any;