TypeScript error in Angular2 code: Cannot find name 'module'

Question

I have defined the following Angular2 component:

import {Component} from 'angular2/core';

@Component({
  selector: 'my-app',
  moduleId: module.id,
  templateUrl: './app.component.html'
})
export class AppComponent {
}

When I try to compile this, I get the following error on line 5:

src/app/app.component.ts(5,13): error TS2304: Cannot find name 'module'.

I believe module.id is referring to the CommonJS module variable (see here). I have specified the CommonJS module system in tsconfig.json:

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "declaration": false,
    "removeComments": true,
    "noLib": false,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "sourceMap": true,
    "pretty": true,
    "allowUnreachableCode": false,
    "allowUnusedLabels": false,
    "noImplicitAny": true,
    "noImplicitReturns": true,
    "noImplicitUseStrict": false,
    "noFallthroughCasesInSwitch": true
  },
  "exclude": [
    "node_modules",
    "dist",
    "typings/browser.d.ts",
    "typings/browser",
    "src"
  ],
  "compileOnSave": false
}

How can I correct the TypeScript error?

I don't think module is something that's provided to you at compile time. — toskv
– toskv, Commented Apr 18, 2016 at 17:47
Well it is compiling correctly for me in this project. I don't know how!!! So I tried to isolate this in a simpler project and it is not working there. So trying to figure out what is making it work in the first project. — Naresh
– Naresh, Commented Apr 18, 2016 at 17:51
You can declare a module.d.ts file with the content: declare var module: any;. Then reference this file from your bootstrap /// <reference path="path/to/typings/module.d.ts" /> — Poul Kruijt
– Poul Kruijt, Commented Apr 18, 2016 at 17:52
@yurzui, you nailed it on the head! Can you please write it out as an answer so that I can mark it correct? — Naresh
– Naresh, Commented Apr 18, 2016 at 18:01

yurzui · Accepted Answer · 2017-10-10 04:10:31Z

102

Update

If you use Typescript 2^ just use the following command:

npm i @types/node --save-dev

(instead of --save-dev you can just use shortcut -D)

or install it globally:

npm i @types/node --global

You can also specify typeRoots or types in your tsconfig.json if you want but by default all visible “@types” packages are included in your compilation.

Old version

You need to install node ambientDependencies. Typings.json

"ambientDependencies": {
    "node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts#138ad74b9e8e6c08af7633964962835add4c91e2",

Another way can use typings manager to install node definition file globally:

typings install dt~node --global --save-dev

Then your typings.json file will look like this:

"globalDependencies": {
  "node": "registry:dt/node#6.0.0+20160608110640"
}

edited Oct 10, 2017 at 4:10

answered Apr 18, 2016 at 18:04

yurzui

215k32 gold badges450 silver badges413 bronze badges

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

5 Comments

Bonneville Over a year ago

Two points: 1. Remember to add the reference to the top of your root typescript file thus: /// <reference path="../../typings/main/ambient/node/index.d.ts" /> 2. Editing the typings.json file as shown by @yurzui worked for me but initially I just did this: > typings install node --ambient --save Which updated the typings.json file [with a different version] and didn't work as the index.d.ts file threw scores of errors at transpile time. FYI: I'm using Angular Beta.16

LEMUEL ADANE Over a year ago

@yurzui How do you add a reference to it from your bootstrap?

Samuel Slade Over a year ago

The command npm install @types/node --save fixed this for me

Slava Fomin II Over a year ago

npm install @types/node --save was enough for me.

mtpultz Over a year ago

Typings should be devDependencies since they are used by TypeScript for type checking and transpiling so they should be installed using npm install -D @types/node since they aren't used in the transpiled code.

msanford · Accepted Answer · 2017-07-26 19:48:13Z

49

For those looking to do this with Typescript 2.x and @types, here's what you need to do:

npm install -D @types/node
Include types: ["node"] under compilerOptions in your tsconfig.json file.

I had a tough time finding the instructions for step 2.

Reference: Typescript issue 9184

Edit:

You could also do:

Include "typeRoots": [ "node_modules/@types" ] under compilerOptions in your tsconfig.json file. This is instead of the types property and has the benefit of automatically including any @types you install with npm.

For example:

{
  "compilerOptions": {
    "typeRoots": [
      "node_modules/@types"
    ]
  }
}

[Second edit] Apparently, with the latest typescript, you only need typeRoots or types if tsconfig.json is not in the root of your project or your types are not stored in node_modules/@types.

edited Jul 26, 2017 at 19:48

msanford

12.4k13 gold badges73 silver badges100 bronze badges

answered Sep 20, 2016 at 20:50

Isaac

2,2331 gold badge15 silver badges15 bronze badges

4 Comments

Isaac Over a year ago

@msanford yes, nested within. I'll make the answer more explicit.

tomups Over a year ago

Thanks so much for step 2! Was bashing my head with this for a couple of days.

Tyguy7 Over a year ago

After adding "types": ["node"] to my compiler options. all my spec.ts test files fail with cannot find name 'expect', 'it', 'describe', 'foreach' etc....

Eric Soyke Over a year ago

Adding types: ["node"] to tsconfig.json didn't work for me. I had to add it in src/tsconfig.app.json. I was upgrading from Angular 8 to 9 and TS 3..5 to 3.8, perhaps something changed since.

TDP · Accepted Answer · 2017-02-27 17:16:52Z

14

I hit this error when porting my @angular/angular2 Quickstart project into a new angular cli auto-generated project.

It seems that moduleId: module.id isn't needed anymore.

This is the latest auto-generated component:

import { Component } from '@angular/core';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {
  title = 'app works!';
}

Removing all occurances resolved my errors.

answered Feb 27, 2017 at 17:16

TDP

1,2411 gold badge10 silver badges26 bronze badges

1 Comment

karora Over a year ago

Thanks - this was the one that did it for me while upgrading from Angular 2 to Angular 5 :-)

asdf_enel_hak · Accepted Answer · 2016-06-08 13:03:56Z

11

Instead of "ambient" try "global" by Typings 1.0

typings install dt~node --global --save

answered Jun 8, 2016 at 13:03

asdf_enel_hak

7,6585 gold badges47 silver badges91 bronze badges

Comments

NAVIN · Accepted Answer · 2018-10-01 18:26:44Z

6

module.id

cannot find the name module.

Follow following steps to resolves this issue,

step 1: Install node module by using the below command

npm i @types/node --save

Step 2: modify the file tsconfig.app.json under src/app

"types": [
    "node"
]

edited Oct 1, 2018 at 18:26

NAVIN

3,3174 gold badges21 silver badges32 bronze badges

answered Oct 1, 2018 at 15:28

Sathish Kumar

611 silver badge2 bronze badges

Comments

Diego · Accepted Answer · 2016-09-13 10:00:36Z

3

Two key points:

Register typings by running typings install dt~node --global --save. So you'll get the following section in typings.json:
```
"globalDependencies": {
    "node": "registry:dt/node#6.0.0+20160608110640"
}
```
Add reference to the new module. Two ways:
- Directly add a reference to a dependency in your TS
  
  /// <reference path="../../../typings/globals/node/index.d.ts" />
- Add typings/index.d.ts in the files section of the tsconfig.json
```
{
    "files": [
        "typings/index.d.ts"
    ]
}
```

See more here.

edited Sep 13, 2016 at 10:00

Diego

86612 silver badges22 bronze badges

answered Sep 13, 2016 at 7:22

Alex Klaus

9,0949 gold badges77 silver badges101 bronze badges

Comments

Petter Friberg · Accepted Answer · 2016-09-23 16:48:15Z

1

I use VS 2015, and had same issues, but I have resolved using:

add the typings.json file from the angular.io website (2.0.0 final at the moment) and the run:
```
typings install // don't forget to install typings globally
```

then

npm install -D @types/node --save

in the package.json I have

"devDependencies": {
"@types/node": "6.0.40",
...

in the typings.json I have the following configuration

{
"compilerOptions": {
    "target": "es5",
    "module":"commonjs",
    "moduleResolution": "node",
    "sourceMap": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "removeComments": true,
    "noImplicitAny": true,
    "suppressImplicitAnyIndexErrors": true,
    "allowSyntheticDefaultImports": true,
    "types": []
},
"exclude": [
    "node_modules",
    "app-dist"
]
}

I had to add the types as an empty array

check for duplicates, and if moduleId: module.id is still highlighted

p.s. to me personally is a strange issue, because as soon as you exclude typings inside typings.json, you have immediately highlighted 'module', but if you let it in, you have lot's of duplicates. Don't know who to blame, me, typescript or visual studio :)

edited Sep 23, 2016 at 16:48

Petter Friberg

21.8k10 gold badges67 silver badges116 bronze badges

answered Sep 23, 2016 at 16:24

Leon

518 bronze badges

1 Comment

Sebas Over a year ago

pretty sure the devDependency to @types/node is enough - typings is not required after that. What may happen is the IDE not finding the reference but that's a different problem. It gets resolved simply by adding /// <reference path="../../../node_modules/@types/node/index.d.ts" /> on top of the file

Kin Cheung · Accepted Answer · 2017-02-08 02:12:12Z

1

This is what I did that worked for me on Eclipse(Webclipse)/Windows.

Step 1:

Terminal

$ npm install @types/node --global --save

Step 2:

tsconfig.json

{
  "compilerOptions": {
    ...,
    "types": ["node"]
  }
}

In addition, I had the following dependencies in my package.json, so I was using typescript 2.

  "devDependencies": {
    ...
    "typescript": "~2.0.10",
    "@types/node": "^6.0.46",
    ...
  },

edited Feb 8, 2017 at 2:12

answered Feb 8, 2017 at 2:07

Kin Cheung

86010 silver badges21 bronze badges

Comments

adam0101 · Accepted Answer · 2019-08-05 18:39:41Z

1

For me, I had a tsconfig.app.json that extended tsconfig.json. So when I added "types": ["node"] in tsconfig.json, it was being overridden by the "types" property in tsconfig.app.json. Adding "node" to the existing "types" property in tsconfig.app.config fixed it.

answered Aug 5, 2019 at 18:39

adam0101

31.5k22 gold badges102 silver badges193 bronze badges

1 Comment

Worthy7 Over a year ago

This was my issue kinda - the default angular tsconfig.app.json defines a blank types: [] which was overwriting not just the parent types but also causes the typeRoots to be ignored

osmarpetry · Accepted Answer · 2019-06-16 00:27:10Z

0

I installed in the project, and worked well

npm install @types/node --save-dev

edited Jun 16, 2019 at 0:27

answered Feb 8, 2017 at 20:20

osmarpetry

731 silver badge5 bronze badges

1 Comment

Ulrich Dohou Over a year ago

Should be --save-dev

Kofi Sammie · Accepted Answer · 2019-12-14 12:50:04Z

0

It still did not work until i pasted this where i had module.id, on top of component. like this

declare var module: NodeModule;
interface NodeModule
{
id: string;
}

@Component({module.id})

answered Dec 14, 2019 at 12:50

Kofi Sammie

3,7071 gold badge19 silver badges18 bronze badges

Collectives™ on Stack Overflow

TypeScript error in Angular2 code: Cannot find name 'module'

11 Answers 11

5 Comments

4 Comments

1 Comment

Comments

Comments

Comments

1 Comment

Comments

1 Comment

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

11 Answers 11

5 Comments

4 Comments

1 Comment

Comments

Comments

Comments

1 Comment

Comments

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related