Issue creating a single .d.ts when using external modules

Question

I'm developing an NPM package using typescript. Within this package the TS files are setup as external modules. The compiler won't generate a single .d.ts for external modules. I'm trying to concat all tsc generated type definitions into a single .d.ts for the entire package.

I'm having issues laying out the single .d.ts file (following a similar approach to that used in grunt-dts-bundle). The condensed example below captures my issue.

Given this external module declaration and test file:

test.d.ts :

declare module "ExternalWrapper" {
    export import Foo = require("FooModule");
}

declare module "FooModule" {
    class Foo {
        name: string;
    }
     export = Foo;
}

test.ts:

import externalWrapper = require( 'ExternalWrapper' );
var t = new externalWrapper.Foo();

Running tsc test.ts test.d.ts -m commonjs produces this error: TS2083: Invalid 'new' expression.

If you change 'test.ts' to look like this, importing 'FooModule' directly:

import Foo = require( "FooModule" );
var t = new Foo();

It compiles fine.

The compiler understands the type externalWrapper.Foo however it doesn't seem to represent it as the same type FooModule.Foo. There is something I'm not getting about how the compilers handles modules that are exported via 'export import'.

Failing the above I'll probably look to manually creating the .d.ts :(

Any help appreciated.

basarat · Accepted Answer · 2014-11-14 02:28:12Z

2

You are probably missing a reference tag:

/// <reference path="test.d.ts"/>

It works :

enter image description here

answered Nov 14, 2014 at 2:28

basarat

278k61 gold badges475 silver badges528 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Keith Over a year ago

cheers, that was it. I've seen your issue on external module .d.ts generations over on the typescript issues list, hopefully this goes away if that gets implemented :)

wjohnsto · Accepted Answer · 2014-11-03 22:15:15Z

2

You should be able to fix this by modifying your .d.ts file to resemble the following:

declare module "ExternalWrapper" {
    import FooModule = require("FooModule");
    export var Foo: typeof FooModule;
}

declare module "FooModule" {
    class Foo {
        name: string;
    }
    export = Foo;
}

With the export import syntax the compiler was assuming you were exporting an instance of Foo, not Foo itself... a little quirky.

answered Nov 3, 2014 at 22:15

wjohnsto

4,5032 gold badges16 silver badges20 bronze badges

Collectives™ on Stack Overflow

Issue creating a single .d.ts when using external modules

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related