[TypeScript] tsconfig.json - esModuleInterop

前言

今天在搭建 react + webpack + typescript 环境的时候,默认导入 react 会提示错误(具体错误内容可以查看:默认导入错误)。

看了下 node_modules 下 react 压缩后的 js 文件使用的模块规范是 CommonJs

在网上搜索后,解决方法是需要在 tsconfig.json 文件中添加 esModuleInterop 参数,本着刨根问底的态度,发现这个参数是在 typescript 2.7 中发布的,下面让我们具体学习了解下这个参数的作用吧。


使用 --esModuleInterop 支持在 CommonJs 模块下使用 import d from 'cjs'

TypeScript 之前对于 CommonJs/AMD/UMD 模块与 ES6 模块处理方式相同,这就导致了一系列的问题。

  • 问题1
    假如 foo 模块的模块规范是CommonJS/AMD/UMD 模块其中的一种,在 ts 文件中使用语句 import * as foo from "foo"TypeScript 会将其等同于 const foo = require("foo")
    看起来很简单,但是它们不能确定要导入的主要对象是原语、类还是函数。ECMAScript 规范规定命名空间记录是一个普通对象,命名空间导入(上面例子中的foo)是不可调用的,尽管 TypeScript允许这样做。

  • 问题2
    假如 foo 模块的模块规范是CommonJS/AMD/UMD 模块其中的一种,在 ts 文件中使用语句 import d from "foo"TypeScript 会将其等同于 const d = require("foo")。但是 CommonJS/AMD/UMD 模块至今没有一个默认导出,造成这个导入模式在非 ES 模块下不能使用。例如 import fs from "fs" 是不被允许的。

// 像下面这样使用基本上会报错,文件名是 index.ts
import Koa from 'koa';
const app = new Koa();

基于 --esModuleInterop 这两种问题都会被解决:

  • 命名空间导入 (即: import * as foo from "foo")现在会被正确标记为不可调用,调用就会报错。
  • 支持从 CommonJS/AMD/UMD 默认导入,并且可以正常工作。

例子:

使用 --esModuleInterop 会生成两个辅助方法 __importStar__importDefault 用于 import * 和 import default。

import * as foo from "foo";
import b from "bar";

编译后:

"use strict";
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
    result["default"] = mod;
    return result;
}
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
}
exports.__esModule = true;
var foo = __importStar(require("foo"));
var bar_1 = __importDefault(require("bar"));
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351