What does "... resolves to a non-module entity and cannot be imported using this construct" mean?

TypescriptEcmascript 6Es6 Modules

Typescript Problem Overview


I have some TypeScript files:

MyClass.ts

class MyClass {
  constructor() {
  }
}
export = MyClass;

MyFunc.ts

function fn() { return 0; }
export = fn;

MyConsumer.ts

import * as MC from './MyClass';
import * as fn from './MyFunc';
fn();

This gives me errors when trying to use new

> Module "MyClass" resolves to a non-module entity and cannot be imported using this construct.

and when trying to call fn()

> Cannot invoke an expression whose type lacks a call signature.

What gives?

Typescript Solutions


Solution 1 - Typescript

Why it doesn't work

import * as MC from './MyClass';

This is ES6/ES2015-style import syntax. The exact meaning of this is "Take the module namespace object loaded from ./MyClass and use it locally as MC". Notably, the "module namespace object" consists only of a plain object with properties. An ES6 module object cannot be invoked as a function or with new.

To say it again: An ES6 module namespace object cannot be invoked as a function or with new.

The thing you import using * as X from a module is defined to only have properties. In downleveled CommonJS this might not be fully respected, but TypeScript is telling you what the behavior defined by the standard is.

What does work?

You'll need to use the CommonJS-style import syntax to use this module:

import MC = require('./MyClass');

If you control both modules, you can use export default instead:

MyClass.ts

export default class MyClass {
  constructor() {
  }
}

MyConsumer.ts

import MC from './MyClass';

I'm Sad About This; Rules are Dumb.

It would have been nice to use ES6 import syntax, but now I have to do this import MC = require('./MyClass'); thing? It's so 2013! Lame! But grief is a normal part of programming. Please jump to stage five in the Kübler-Ross model: Acceptance.

TypeScript here is telling you this doesn't work, because it doesn't work. There are hacks (adding a namespace declaration to MyClass is a popular way to pretend this works), and they might work today in your particular downleveling module bundler (e.g. rollup), but this is illusory. There aren't any ES6 module implementations in the wild yet, but that won't be true forever.

Picture your future self, trying to run on a neato native ES6 module implementation and finding that you've set yourself up for major failure by trying to use ES6 syntax to do something that ES6 explicitly doesn't do.

I want to take advantage of my non-standard module loader

Maybe you have a module loader that "helpfully" creates default exports when none exist. I mean, people make standards for a reason, but ignoring standards is fun sometimes and we can think that's a cool thing to do.

Change MyConsumer.ts to:

import A from './a';

And specify the allowSyntheticDefaultImports command-line or tsconfig.json option.

Note that allowSyntheticDefaultImports doesn't change the runtime behavior of your code at all. It's just a flag that tells TypeScript that your module loader creates default exports when none exist. It won't magically make your code work in nodejs when it didn't before.

Solution 2 - Typescript

TypeScript 2.7 introduces support by emitting new helper methods: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#support-for-import-d-from-cjs-form-commonjs-modules-with---esmoduleinterop

So in tsconfig.json add these two settings:

{
    // Enable support for importing CommonJS modules targeting es6 modules
    "esModuleInterop": true,

    // When using above interop will get missing default export error from type check since
    // modules use "export =" instead of "export default", enable this to ignore errors.
    "allowSyntheticDefaultImports": true
}

And now you can use:

import MyClass from './MyClass';

Solution 3 - Typescript

Adding my 2 cents here incase someone else have this issue.

My way of working around the issue without modifying tsconfig.json (which can be problematic in some projects), I've gone with simply disabling the rule for oneline.

import MC = require('./MyClass'); // tslint:disable-line

Solution 4 - Typescript

I got this error when trying to include a npm debounce package in my project.

When I tried the accepted solution above I got an exception:

> Import assignment cannot be used when targeting ECMAScript modules. > Consider using 'import * as ns from "mod"', 'import {a} from "mod"', > 'import d from "mod"', or another module format instead.

This ended up working:

import debounce from 'debounce' 

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionRyan CavanaughView Question on Stackoverflow
Solution 1 - TypescriptRyan CavanaughView Answer on Stackoverflow
Solution 2 - TypescriptMichaelView Answer on Stackoverflow
Solution 3 - TypescriptShahar HadasView Answer on Stackoverflow
Solution 4 - TypescriptNSjonasView Answer on Stackoverflow