Typescript：无法在模块外使用导入语句

Question

I have a.ts file in node.js (latest version of node.js for 07.10.19) app with importing node-module without default export. I use this construction: import { Class } from 'abc'; When i run the code, i have this error: Cannot use import statement outside a module .

In the.network i see many solutions for this problem (for.js), but it not helps to me, maybe because i have typescript file. Here's my code:

import { Class } from 'abc';
module.exports = { ...
    execute(a : Class ,args : Array<string>){ ...

Here's my tsconfig.json:

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",

    "strict": true
  }
}

Answer 1

Update: Because this answer is getting significant views I have updated it to better show the available solutions for this problem in 2022.

---

The error means Node found an import statement in a file that it does not consider an ECMAScript (ES) module. Adding "type": "module" to package.json will tell Node you are using ES modules, but then you will need to tell the TypeScript compiler to emit this type of module by setting "module": "es2015" or higher (for example: "es2020" ) in tsconfig.json . If you want to emit CommonJS modules ( require ), set "module": "commonjs" .

In case you don't want to set the module system at the project level, there are more fine-grained options. Files with the .mjs extension are always treated as ES modules, while files with .cjs are always treated as CommonJS modules. As of TypeScript 4.5 it is possible to use the .mts and .cts extensions as well and have the compiler emit .mjs or .cjs files, respectively.

The two systems are partially compatible. For example, it is possible to import a CommonJS module into an ES module with a default export:

// in an ES module
import thing from "./main.cjs";

The other way around. an ES module may be imported into a CommonJS module with dynamic import (ES2020 features are needed for this to work):

// in a CommonJS module
const thing = await import("./main.mjs");

---

Original answer (2020):

Adding "type": "module" to package.json will tell Node you are using ES2015 modules, which should get rid of the error, but then you will need to tell Typescript to generate this type of module by setting "module": "es2015" instead of "commonjs" in tsconfig.json .

This however causes a problem with the current code because although you are using an ES6 import {} statement you are exporting using the commonJS module.exports = {} syntax, and Node's ES module loader will have an issue with it. There are two ways to deal with it:

• Keep the module.exports but tell Node to interpret this file as commonJS by giving it a.cjs extension.
• Change the export statement to ES2015 syntax: export function execute(…)..

The first option could get a bit tricky because the compiler will output.js files and you'd have to change it to.cjs all the time (as far as I know). With the second option you should be able to run the file with Node (including the --experimental-modules flag for versions < 13.8).

If you absolutely need to use commonJS, perhaps it is better to install the type definitions for Node: @types/node and change the import to commonJS format: require('abc') and keep the rest of the settings as they are (though you can add "type": "commonjs" to package.json to be explicit).

Answer 2

Make sure your "main" field in package.json is pointing to the compiled index.js and not the index.ts

Answer 3

If you happen to be using ts-node , you can set some compiler options in tsconfig.json specifically for ts-node to use.

{
  "ts-node": {
    // these options are overrides used only by ts-node
    // same as the --compilerOptions flag and the TS_NODE_COMPILER_OPTIONS environment variable
    "compilerOptions": {
      "module": "commonjs"
    }
  },
  "compilerOptions": {
    "module": "esnext"
  }
}

Then you can just execute your script pretty easily:

$ ts-node my-script.ts

Answer 4

I had very similar issue. I had to install nodemon and always start script through nodemon index.ts

yarn add -D nodemon

package.json

"scripts": {
   "start": "nodemon index.ts"
}

or to specify the file from the command line

package.json

"scripts": {
   "nodemon": "nodemon $1"
}

Answer 5

There can be a lot of of possibilities for getting,

SyntaxError: Cannot use import statement outside a module

while running typescript.

In my setup, I was importing a module called, AbModule ( AbModule has class AbClassName ) from my script testab.ts .

testab.ts had import stmt ,

import {AbClassName} = 'testAdapterDir/AbModule.po.ts';

However, AbModule had all *.ts files and there were *.js files were not present. fix is,

You may get errors in running the below code but you can safely ignore them.

cd AbModule path
tsc *.ts

Now AbModule should contain compiled files all *.js too. Now run testab.ts and noticed that the mentioned error does not exist anymore,

Answer 6

In tsconfig.json set:

  "ts-node": {
    "compilerOptions": {
      "module": "CommonJS"
    }
  }

Answer 7

Solution if "type": "module" is NOT an option

• rename .ts to .mts
• run ts-node --esm file.mts

here's my tsconfig.json for reference:

{
  "compilerOptions": {
    "incremental": true,
    "target": "ESNext",
    "module": "ESNext",
    "allowJs": true,
    "checkJs": false,
    "outDir": "./dist",
    "sourceMap": true,
    "strict": true,
    "alwaysStrict": true,
    "moduleResolution": "node",
    "esModuleInterop": true
  },
  "include": ["**/*"]
}

Answer 8

I had similar issue with one Node TypeScript project. I needed some features of ESM, and when changed "target" and "module" in tsconfig.json to ESNext , I've got an error "Cannot use import statement outside a module".

The solution helped me was:

1. implement "type": "module" in package.json
2. implement "target": "ESNext" and "module": "NodeNext" in tsconfig.json (afterwards I checked that "module": "ESNext" worked as well by the way)
3. change all import statement in *.ts files adding js extension like this import { AccountGroup } from "./AccountGroup.js" (despite that actual code in TypeScript project before compilation is inside AccountGroup.ts file)

Solution was found here and was inspired by this source

Answer 9

install package ts-node and change your package.json

"scripts": {
    "dev": "ts-node index.ts"
  }

UPD: This can occur while using ts-node