Typescript: Add ability to generate ambient declarations for external commonjs modules

Created on 21 Nov 2014 · 12Comments · Source: microsoft/TypeScript

Badly needed for commonjs modules where you are more likely to ship JS code plus a generated .d.ts file.

From codeplex : https://typescript.codeplex.com/workitem/2080

Suggestion

Source

basarat

Most helpful comment

:+1:
We need tsc allow below syntax.

$ cat index.d.ts
// hand assemble
declare module "foobar" {
  export * from "./lib/main";
}

but, now we got below error message.

$ tsc --module commonjs index.d.ts
index.d.ts(3,3): error TS2439: Import or export declaration in an ambient module declaration cannot reference module through relative module name.

vvakame on 28 Jul 2015

👍3

All 12 comments

current workaround : https://github.com/TypeStrong/dts-bundle and https://github.com/TypeStrong/grunt-dts-bundle

basarat on 21 Nov 2014

This is related to, if not a duplicate of https://github.com/Microsoft/TypeScript/issues/575

Also I completely agree with emphasis. This is by far the biggest road block when trying to make use of Typescript within our organization.

xealot on 22 Nov 2014

Absolutely :+1:

The dts-bundle package (an admitted kludge) is the only way I was able to find to make commonjs modules resusable across projects. It was painful enough that I just switched to internal modules and shoved all the dependency management into my build script. Would be awesome to have commonjs modules "just work".

sccolbert on 24 Nov 2014

I believe this is a duplicate of, or very related to #17

We're using dts-bundle to get around this, it'd be great to have compiler support.

KeithWoods on 2 Dec 2014

+1. We really really really need this.

niemyjski on 22 Apr 2015

+1. It would be really useful.

OvidiuGuta on 28 Jul 2015

:+1:
We need tsc allow below syntax.

$ cat index.d.ts
// hand assemble
declare module "foobar" {
  export * from "./lib/main";
}

but, now we got below error message.

$ tsc --module commonjs index.d.ts
index.d.ts(3,3): error TS2439: Import or export declaration in an ambient module declaration cannot reference module through relative module name.

vvakame on 28 Jul 2015

👍3

mribichich on 12 Jan 2016

Now that the compiler supports node module resolution this can be closed as far as I am concerned :rose:

basarat on 1 Mar 2016

If @basarat says it's good it's good with me too :smiley:

RyanCavanaugh on 1 Mar 2016

@basarat can you show how this can be done? I want to do the very thing the error is saying cannot be done. What is the alternative?
'Import or export declaration in an ambient module declaration cannot reference module through relative module name.'