Wrap Typescript definition file in module automatically

Question

I am most probably missing some tsconfig option here.

What Im doing is pretty simple:

I am creating an npm module, for example:

export class HelloWorld {
    constructor(public greeting: string){}
}

with my tsconfig being:

{
  "compilerOptions": {
    "target": "ES5",
    "module": "commonjs",
    "removeComments": true,
    "noImplicitAny": false,
    "preserveConstEnums": true,
    "declaration": true,
    "suppressImplicitAnyIndexErrors": true,
    "outDir": "../js"
  },
  "filesGlob": [
    "./**/*.ts",
    "!./node_modules/**/*.ts"
  ]
}

When my declaration is automatically created it looks like this:

export declare class HelloWorld {
    greeting: string;
    constructor(greeting: string);
}

But that doesnt work well when actually installing the npm package in other projects. When I import the package I have to use:

import hello = require("hello-world/js/index");

(for example)

I found out that when I wrap the declaration file in module declare module "hello-world" {...} Then I can import it as desired by import hello = require("hello-world");

Wrapping the generated definition file manually is not an option as it rewrites itself all the time, is there any option that would take name of the package from package.json and automatically wrap the definition in that module?

Have a look at this article which explains where does typescript look for typings,etc: ivanz.com/2016/06/07/… — Ivan Zlatev
– Ivan Zlatev, Commented Jun 10, 2016 at 15:25

David Sherret · Accepted Answer · 2016-06-10 15:24:16Z

1

Make sure you have a typings property specified in package.json...

{
    "name": "hello-world",
    "typings": "hello-world.d.ts",
    ...etc...
}

...or change your definition file to be named index.d.ts.

Then after installing the package with these changes, the compiler will be able to resolve it when you write:

import hello = require("hello-world");

More details

answered Jun 10, 2016 at 15:24

David Sherret

108k28 gold badges197 silver badges190 bronze badges

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

2 Comments

Ivan Zlatev Over a year ago

import {HelloWorld} from 'hello-world'; new HelloWorld("greeting here"); instead of require ?

David Sherret Over a year ago

@IvanZlatev I always use es6 modules, but I just used require because they used it as well. My memory of exactly how require works is slowly fading to be honest :)

Collectives™ on Stack Overflow

Wrap Typescript definition file in module automatically

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related