Can I import a TypeScript class from my own module to global?

Question

I have a class in a module.

module Foo {
    export class Bar {

    } 

    /* Some more interfaces and classes to be used only in this module */
}
var bar = new Foo.Bar();

This class is for a library, and I don't want other users to write Foo.Bar but just Bar to use my Bar class:

var bar = new Bar();

I can do this by defining a new variable Bar.

var Bar = Foo.Bar;

var bar = new Bar();

However, now I have a problem. I cannot use the Bar as a TypeScript type identifier.

function something(bar: Bar) { // Compiler: Could not find symbol 'Bar'.

}

I can also solve this problem by defining a new class that extends Foo.Bar.

class Bar extends Foo.Bar {

}

var bar = new Bar();
function something(bar: Bar) {

}

However, the resulting Bar class is not exactly same with Foo.Bar, as Bar === Foo.Bar and Bar.prototype === Foo.Bar.prototype both returns false.

I tried to find a method using TypeScript module feature such as import and require, but it seems I cannot do this with them. Is there any good method to expose my Bar class to global?

basarat · Accepted Answer · 2014-07-21 10:30:27Z

2

Instead of

interface Bar extends Foo.Bar {
}
var Bar = Foo.Bar;

You can simply do :

import Bar = Foo.Bar;

Complete Example :

module Foo {
    export class Bar {
        x: number
    } 

    /* Some more interfaces and classes to be used only in this module */
}

import Bar = Foo.Bar;

var bar = new Bar();
function something(bar: Bar) {

}

answered Jul 21, 2014 at 10:30

basarat

278k61 gold badges475 silver badges528 bronze badges

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

3 Comments

Kagami Sascha Rosylight Over a year ago

Much simpler! This is what I want. Thank you very much!

Kagami Sascha Rosylight Over a year ago

Oops. Resulting d.ts file now does not includes Bar as global class object. Hmm...

Kagami Sascha Rosylight Over a year ago

The d.ts problem seems to be fixed in the new compiler. See: github.com/Microsoft/TypeScript/issues/346 Anyone who uses current version 1.1 compiler should add import Bar = Foo.Bar; line in d.ts file by themselves.

Kagami Sascha Rosylight · Accepted Answer · 2014-07-21 10:22:33Z

0

It turns out that this works as intended.

module Foo {
    export class Bar {
        x: number
    } 

    /* Some more interfaces and classes to be used only in this module */
}
interface Bar extends Foo.Bar {
}
var Bar = Foo.Bar;

var bar = new Bar();
function something(bar: Bar) {

}

Thanks!

answered Jul 21, 2014 at 10:22

Kagami Sascha Rosylight

1,5122 gold badges16 silver badges31 bronze badges

Comments

Eric Nicholson · Accepted Answer · 2014-07-21 13:30:41Z

0

I'm not sure you want/need a module at all, just export the class:

class Bar {
   x: number;
}

/* Some more interfaces and classes to be used only in this module */

export = Bar;

and then in the consuming code:

import Bar = require('./Bar');
var bar = new Bar();

answered Jul 21, 2014 at 13:30

Eric Nicholson

4,1031 gold badge30 silver badges29 bronze badges

1 Comment

Kagami Sascha Rosylight Over a year ago

This method seems to require users use 'require'. This is not a problem, but I prefer to make things simplest and import Bar = Foo.Bar was what I exactly want! Thank you for answering :)

Collectives™ on Stack Overflow

Can I import a TypeScript class from my own module to global?

3 Answers 3

Instead of

Complete Example :

3 Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Instead of

Complete Example :

3 Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related