欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

关于TypeScript模块导入的那些事

程序员文章站 2022-07-01 20:46:05
前言 模块在其自身的作用域里执行,而不是在全局作用域里;这意味着定义在一个模块里的变量,函数,类等等在模块外部是不可见的,除非你明确地使用export之一导出它们。 相反...

前言

模块在其自身的作用域里执行,而不是在全局作用域里;这意味着定义在一个模块里的变量,函数,类等等在模块外部是不可见的,除非你明确地使用export之一导出它们。 相反,如果想使用其它模块导出的变量,函数,类,接口等的时候,你必须要导入它们,可以使用import之一。

模块是自声明的。在typescript里,两个模块之间的关系是通过在文件级别上使用import和export建立的。

下面话不多说了,来一起看看详细的介绍吧

es6 模块导入的限制

我们先来看一个具体的例子:

在 node 项目里,使用 commonjs 规范引入一个模块:

const koa = require('koa')

改写为 typescript(1.5+ 版本)时,通常有两种方式:

使用 es6 模块导入方式:

// allowsyntheticdefaultimports: false
import * as koa from 'koa'

使用 typescript 模块导入语法:

import koa = require('koa')

两者大部分是等价的,但 es6 规范对 import * as 创建出的模块对象有一点限制。

根据该规范,该模块对象不可被调用,也不可被实例化,它只具有属性。

因此,如果你想调用该对象,或者使用 new 方法,在 allowsyntheticdefaultimports: false 的配置下,应该使用例子中的第二种方式。

2.7 版本对 commonjs/amd/umd 模块导入的增强

在之前的版本,typescript 对 commonjs/amd/umd 模块的处理方式与 es6 模块相同,这会导致一些问题:

  • 如前文所提到的,当导入一个 commonjs/amd/umd 模块时,typescript 视 import * as koa from 'koa' 与 const koa = require('koa') 等价,但使用 import * as 创建的模块对象实际上不可被调用以及被实例化。
  • 类似的,当导入一个 commonjs/amd/umd 模块时,typescript 视 import foo from 'foo' 与 const koa = require('koa').default 等价,但在大部分 commonjs/amd/umd 模块里,它们并没有默认导出。

在 2.7 的版本里,typescript 提供了一个新选项 --esmoduleinterop,旨在解决上述问题,
当使用该选项,且模块为 commonjs/amd/umd 时,它会导入一个可调用或是可实例化的模块,同时它规定该模块必须作为默认导入:

import koa from 'koa'
const app = new koa()

模块导入仅仅是一些声明类型

在以非相对路径导入一个模块时,你可能会看到 could not find a declaration file for module 'somemodule' 的错误, 此时你可以安装对应模块的声明文件或者写一个包含 declare module 'somemodule' 的声明文件。
实际上,当我们导入一个模块时:

import koa from 'koa'
// import koa = require('koa')

它所做的事情只有两个:

  • 导入模块的所有类型信息;
  • 确定运行时的依赖关系。

当你加载此模块,但并没有使用,或仅当作类型来使用时,编译后,此模块将会被移除。

当不使用时;

import koa from 'koa'

编译后:

仅当做类型使用时:

import koa from 'koa'
let k: koa

编译后:

var k

做为值使用时,编译后,此模块将会被保留:

import koa from 'koa'
const app = new koa()

编译后(假设使用 commonjs):

var __importdefault = (this && this.__importdefault) || function (mod) {
 return (mod && mod.__esmodule) ? mod : { "default": mod };
};
var koa_1 = __importdefault(require("koa"));
var k = new koa_1.default();

注: __importdefault 为使用 --esmoduleinterop 选项时产生的方法。

参考

http://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html
https://*.com/questions/35706164/typescript-import-as-vs-import-require?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
https://basarat.gitbooks.io/typescript/content/docs/project/external-modules.html

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。