TypeScript typings give me "index.d.ts is not a module"

Question

I am getting File node_modules/@types/webrtc/index.d.ts is not a module with this code:

import * as webrtc from "webrtc";
const peerConnection1 = new RTCPeerConnection();

I have installed the typings using npm i @types/webrtc --save-dev. Hovering over RTCPeerConnection in const peerConnection1 = new RTCPeerConnection(); display type annotations in Visual Studio Code so at least the code editor sees the types. Running tsc (or webpack with ts-loader) fails with the error.

I have tried npm i webrtc --save in a misguided attempt for solving this, but it did not change anything and I really only want the typings anyway, WebRTC is right there in the browser, I don't need a package for that. (Support aside.)

The index.d.ts file indeed is not a module, it just references two other files with interfaces in them. So I thought to remove import * as webrtc from "webrtc"; hoping the typings will still be visible by tsc somehow. (But that's impossible since I exclude node_modules in TypeScript config file.) When I do that RTCPeerConnection is no longer recognized.

Adding /// <reference src="node_modules/@types/webrtc/" /> did not help, tsc says Invalid reference directive syntax.

You can view a repository with minimal repro here on GitLab. I am not too well versed in TypeScript typings acquisition so please forgive my ignorance if I'm going about this all wrong.

Meirion Hughes · Accepted Answer · 2017-01-16T13:43:01.250

66

webrtc is part of the browser; you're trying to import a module. Simply import the (typings) library:

import "webrtc";

you may need to use "moduleResolution": "node" in the compiler options.

Alternatively use the "types": ["webrtc"] compiler option and the compiler will automatically load those types up for you.

edited Jan 16 '17 at 13:43

answered Nov 05 '16 at 17:52

Meirion Hughes

21,021
8
65
114

score 10 · Answer 2 · answered Nov 05 '16 at 22:41

10

You probably want to add

"types": ["webrtc"]

to your tsconfig.json, or less preferrably, to use

/// <reference types="webrtc" />

in your source files. Here's an example of it in your tsconfig.json:

{
    "compilerOptions": {
        "target": "es5",
        "sourceMap": true,
        "noImplicitAny": true,

        "types": ["webrtc"]
    },
    "exclude": [
        "node_modules"
    ]
}

This tells TypeScript it should include webrtc declarations in your build

answered Nov 05 '16 at 22:41

Daniel Rosenwasser

15,697
7
40
57

2

Don't set `types` or else *only* those types will get loaded — usually everything in `node_modules/@types` is loaded, and this will prevent that behaviour. You simply need to `npm i @types/webrtc` these days. – aendrew Mar 21 '18 at 14:15
@aendrew that isn't entirely true because it depends on where your `tsconfig.json` is placed relative to your `node_modules` directory. – Daniel Rosenwasser Mar 21 '18 at 23:26

score 7 · Answer 3 · answered Sep 08 '17 at 20:00

7

Another option is to add a new declaration file *.d.ts in your module, i.e.:

declare module 'my-module';

answered Sep 08 '17 at 20:00

Karolis Grinkevičius

477
5
6

score 6 · Answer 4 · answered Jul 05 '17 at 08:25

6

No need to import anything, run following:

npm install --save @types/webrtc
update tsconfig.json -

"types": [ "@types/webrtc" ]

answered Jul 05 '17 at 08:25

Sabir Hussain

93
2
5

1

This will make it so that only the webrtc types are imported. Don't update tsconfig.json. – aendrew Mar 21 '18 at 14:13
2

`npm install --save-dev @types/...` is preferred - normally, TS is not used in production – Nino Filiu Dec 13 '18 at 17:41

score 1 · Answer 5 · answered Dec 13 '17 at 20:32

1

/// <reference types="@types/<your_types_module>" />

You may or may not want to do this depending on your build and style needs, but this seems to be the quick (and dirty) fix.

answered Dec 13 '17 at 20:32

youngrrrr

2,285
3
20
39

score 0 · Answer 6 · answered Feb 10 '21 at 15:21

0

use require

const webRtc = require('webrtc');

and you import should be good to go

answered Feb 10 '21 at 15:21

Ion Scorobogaci

91
1
4

score 0 · Answer 7 · answered Feb 19 '21 at 11:35

0

In my case it was a corrupted dependency, deleting the module and npm install did the work.

answered Feb 19 '21 at 11:35

Rajantha Fernando

89
1
8

TypeScript typings give me "index.d.ts is not a module"

7 Answers7

Linked