Typescript参考手册
项目配置 | Project Configuration
Compiler Options
编译器选项
选项 |
类型 |
默认 |
描述 |
---|---|---|---|
--allowJs |
布尔 |
假 |
允许编译JavaScript文件。 |
--allowSyntheticDefaultImports |
布尔 |
模块===“系统” |
允许默认从默认导出模块导入。这不会影响代码排放,只是类型检查。 |
--allowUnreachableCode |
布尔 |
假 |
不要在无法访问的代码上报告错误。 |
--allowUnusedLabels |
布尔 |
假 |
不要在未使用的标签上报告错误。 |
--alwaysStrict |
布尔 |
假 |
以严格模式解析,并为每个源文件发出“严格使用” |
--baseurl |
串 |
|
用于解析非相对模块名称的基本目录。有关详细信息,请参阅模块解析文档 |
--charset |
串 |
“UTF-8” |
输入文件的字符集。 |
--checkJs |
布尔 |
假 |
报告.js文件中的错误。与--allowJs结合使用。 |
--declaration-d |
布尔 |
假 |
生成相应的.d.ts文件。 |
--declarationDir |
串 |
|
输出生成的声明文件的目录。 |
--diagnostics |
布尔 |
假 |
显示诊断信息。 |
--disableSizeLimit |
布尔 |
假 |
禁用JavaScript项目的大小限制。 |
--downlevelIteration |
布尔 |
假 |
在针对ES5或ES3时,全面支持for..of,spread和destructure中的iterables。 |
--emitBOM |
布尔 |
假 |
在输出文件的开始处发出UTF-8字节顺序标记(BOM)。 |
--emitDecoratorMetadata1 |
布尔 |
假 |
为源中的装饰声明提供设计类型元数据。有关详细信息,请参阅问题#2577。 |
--experimentalDecorators1 |
布尔 |
假 |
为ES装饰器启用实验性支持。 |
--forceConsistentCasingInFileNames |
布尔 |
假 |
不允许不一致地引用同一个文件。 |
--help-H |
|
|
打印帮助信息。 |
--importHelpers |
布尔 |
假 |
导入从tslib发射助手(例如__extends,__rest等) |
--inlineSourceMap |
布尔 |
假 |
用源图发射单个文件而不是单独的文件。 |
--inlineSources |
布尔 |
假 |
在单个文件中与源代码一起发出源代码; 需要设置--inlineSourceMap或--sourceMap。 |
- 在里面 |
|
|
初始化一个TypeScript项目并创建一个tsconfig.json文件。 |
--isolatedModules |
布尔 |
假 |
将每个文件作为单独的模块传输(类似于“ts.transpileModule”)。 |
- jsx |
串 |
“保留” |
在.tsx文件中支持JSX:“反应”或“保留”。参见JSX。 |
--jsxFactory |
串 |
“React.createElement” |
指定JSX工厂函数以在定位反应JSX放射时使用,例如React.createElement或h。 |
--lib |
串[] |
|
可用的值包括:►ES5►ES6►ES2015►ES7►ES2016►ES2017►ESNext►DOM►DOM.Iterable►WebWorker►ScriptHost►ES2015.Core►ES2015.收集►ES2015。发电机►ES2015.Iterable►ES2015.Promise►ES2015.Proxy►ES2015.Reflect►ES2015.Symbol►ES2015.Symbol.WellKnown►ES2016.Array.Include►ES2017.object►ES2017.SharedMemory►esnext.asynciterable注意:如果 - 没有指定lib,注入默认库。注入的默认库为:►用于--target ES5:DOM,ES5,ScriptHost►用于--target ES6:DOM,ES6,DOM.Iterable,ScriptHost |
--listemittedfiles |
布尔 |
假 |
生成文件的名称部分编译。 |
--listFiles |
布尔 |
假 |
打印汇编文件的部分名称。 |
--locale |
串 |
(平台特定) |
用于显示错误消息的区域设置,例如en-us。 |
--mapRoot |
串 |
|
指定调试器应该找到映射文件而不是生成位置的位置。如果.map文件将在运行时位于与.js文件不同的位置,请使用此标志。指定的位置将被嵌入到sourceMap中,以指导调试器将映射文件所在的位置。 |
--maxNodeModuleJsDepth |
数 |
0 |
在node_modules和加载JavaScript文件下搜索的最大依赖深度。只适用于--allowJs。 |
--module-m的 |
串 |
目标===“ES3”或“ES5”?“CommonJS”:“ES6” |
指定模块代码生成:“无”,“CommonJS”,“AMD”,“系统”,“UMD”,“ES6”,“ES2015”或“ESNext”。只能使用“AMD”和“系统”与--outFile结合使用。?当定位“ES5”或更低时,可以使用“ES6”和“ES2015”值。 |
--moduleResolution |
串 |
模块===“AMD”或“系统”或“ES6”?“经典”:“节点” |
确定模块如何解决。Node.js / io.js风格分辨率的“Node”或“Classic”。有关详细信息,请参阅模块解析文档 |
- 新队 |
串 |
(平台特定) |
发射文件时使用指定的行序列末尾:“crlf”(窗口)或“lf”(unix)。“ |
--noEmit |
布尔 |
假 |
不要发出输出。 |
--noEmitHelpers |
布尔 |
假 |
不要在编译输出中生成像__extends这样的自定义辅助函数。 |
--noEmitOnError |
布尔 |
假 |
如果报告了任何错误,请不要输出输出。 |
--noFallthroughCasesInSwitch |
布尔 |
假 |
在switch语句中报告故障案例的错误。 |
--noImplicitAny |
布尔 |
假 |
在表达式和声明上引发任何类型的隐含错误。 |
--noImplicitReturns |
布尔 |
假 |
当函数中的所有代码路径都不返回值时报告错误。 |
--noImplicitThis |
布尔 |
假 |
用暗示的任何类型在此表达式上引发错误。 |
--noImplicitUseStrict |
布尔 |
假 |
不要在模块输出中发出“使用严格”指令。 |
--noLib |
布尔 |
假 |
不要包含默认库文件(lib.d.ts)。 |
--noResolve |
布尔 |
假 |
不要将三斜杠引用或模块导入目标添加到已编译文件的列表中。 |
--noStrictGenericChecks |
布尔 |
假 |
禁用函数类型中的通用签名的严格检查。 |
--noUnusedLocals |
布尔 |
假 |
报告未使用的当地人的错误。 |
--noUnusedParameters |
布尔 |
假 |
报告未使用参数的错误。 |
--out |
串 |
|
已过时。改用--outFile。 |
--outDir |
串 |
|
将输出结构重定向到目录。 |
--outfile |
串 |
|
连接并将输出发送到单个文件。连接顺序由在命令行中传递给编译器的文件列表以及三斜杠引用和导入来决定。请参阅输出文件订单文档以获取更多详细信 |
paths2 |
目的 |
|
模块名称到相对于baseUrl的位置的路径映射条目列表。有关详细信息,请参阅模块解析文档 |
--preserveConstEnums |
布尔 |
假 |
不要擦除生成的代码中的常量枚举声明。有关更多详细信息,请参阅const enums文档。 |
--preserveSymlinks |
布尔 |
假 |
不要将符号链接解析为其真实路径; 对待像一个真正的符号链接文件。 |
--pretty1 |
布尔 |
假 |
使用颜色和上下文风格化错误和消息。 |
--project-P |
串 |
|
编译一个给定有效配置文件的项目。参数可以是有效JSON配置文件的文件路径,也可以是包含tsconfig.json文件的目录的目录路径。有关更多详细信息,请参阅tsconfig.json文档。 |
--reactNamespace |
串 |
“响应” |
已过时。改为使用--jsxFactory。指定在针对“react”JSX发射时为createElement和__spread调用的对象。 |
--removeComments |
布尔 |
假 |
除去以/ *开头的版权标题注释,删除所有评论 |
--rootDir |
串 |
(公共根目录是从输入文件列表中计算出来的) |
指定输入文件的根目录。仅用于使用--outDir来控制输出目录结构。 |
rootDirs2 |
串[] |
|
组合内容表示运行时项目结构的根文件夹列表。有关详细信息,请参阅模块解析文档 |
--skipDefaultLibCheck |
布尔 |
假 |
已过时。改用--skipLibCheck.Skip类型检查默认库声明文件。 |
--skipLibCheck |
布尔 |
假 |
跳过所有声明文件的类型检查(* .d.ts)。 |
--sourceMap |
布尔 |
假 |
生成相应的.map文件。 |
--sourceRoot |
串 |
|
指定调试器应该找到TypeScript文件而不是源位置的位置。如果源将在运行时位于与设计时不同的位置,请使用此标志。指定的位置将被嵌入到sourceMap中,以指导调试器将源文件放置在哪里。 |
- 严格 |
布尔 |
假 |
启用所有严格的类型检查选项。启用--strict启用--noImplicitAny,--noImplicitThis,--alwaysStrict和--strictNullChecks。 |
--strictNullChecks |
布尔 |
假 |
在严格的空检查模式下,空值和未定义值不在每个类型的域中,只能分配给它们自己和任何类型(一个例外是未定义的也可分配给void)。 |
--stripInternal1 |
布尔 |
假 |
不要为具有/ ** @internal * / JSDoc批注的代码发出声明。 |
--suppressExcessPropertyErrors |
布尔 |
假 |
抑制对象文字的多余属性检查。 |
--suppressImplicitAnyIndexErrors |
布尔 |
假 |
抑制--noImplicit对索引缺乏索引签名的对象进行索引的任何错误。有关更多详细信息,请参阅问题#1232。 |
--target-T |
串 |
“ES3” |
指定ECMAScript目标版本:“ES3”(默认),“ES5”,“ES6”/“ES2015”,“ES2016”,“ES2017”或“ESNext”。注意:“ESNext”以最新支持的ES建议功能为目标。 |
--traceResolution |
布尔 |
假 |
报告模块解析日志消息。 |
--types |
串[] |
|
包含的类型定义的名称列表。有关更多详细信息,请参阅@types,-typeRoots和-types。 |
--typeRoots |
串[] |
|
要包含类型定义的文件夹列表。有关更多详细信息,请参阅@types,-typeRoots和-types。 |
--version-V |
|
|
打印编译器的版本。 |
--watch-W |
|
|
在监视模式下运行编译器。观看输入文件并在更改时触发重新编译。 |
- 1 这些选项是实验性的。
- 2 这些选项只允许在
tsconfig.json
命令行开关中,而不能通过命令行开关。
有关
- 在
tsconfig.json
文件中设置编译器选项。
- 在 MSBuild 项目中设置编译器选项。
项目配置 | Project Configuration相关
TypeScript 是 JavaScript 的类型的超集,它可以编译成纯 JavaScript。编译出来的 JavaScript 可以运行在任何浏览器上。
主页 | https://www.typescriptlang.org |
源码 | https://github.com/Microsoft/TypeScript |
发布版本 | 2.6.0 |