JavaScript 中怎么在 JavaScript 项目中引入 TypeScript 进行类型检查

雨瑶小哥_8876

雨瑶小哥_8876

2026-08-11

875人浏览

原创

不是重写所有文件,而是通过渐进式方式启用类型检查:先配置tsconfig.json启用allowjs和checkjs,再用jsdoc为js文件添加类型注释,辅以.d.ts声明补全类型,最后集成type-check脚本实现开发时提示与ci门禁。

javascript 中怎么在 javascript 项目中引入 typescript 进行类型检查

在现有 JavaScript 项目中引入 TypeScript,**不是要把所有文件重写成 .ts**,而是通过渐进式方式启用类型检查,保留原有 JS 代码的同时获得类型提示和错误预警。核心是利用 TypeScript 的“JavaScript 模式”(checkJs)和类型声明支持。

1. 安装 TypeScript 并初始化配置

在项目根目录运行:

  • npm install --save-dev typescript
  • npx tsc --init 生成 tsconfig.json

然后在 tsconfig.json 中启用对 JS 文件的检查:

{
  "compilerOptions": {
    "allowJs": true,
    "checkJs": true,
    "skipLibCheck": true,
    "noEmit": true,
    "strict": false,
    "jsx": "preserve",
    "moduleResolution": "node"
  },
  "include": ["**/*.js", "**/*.jsx"],
  "exclude": ["node_modules"]
}

注意:"noEmit": true 表示只检查、不编译输出,避免干扰现有构建流程;"strict": false 降低初始门槛,后续可逐步开启(如 strictNullChecks)。

2. 为 JS 文件添加类型注释(可选但推荐)

TypeScript 能理解 JSDoc 注释,用于标注类型。例如:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
// utils.js
/**
 * @param {string} name
 * @param {number} age
 * @returns {Object}
 */
function createUser(name, age) {
  return { name, age };
}
<p>// 调用时如果传错类型,TS 会报错
createUser("Alice", "30"); // ❌ 类型错误:age 应为 number
</p>

常见 JSDoc 类型写法:

  • @type {Array<string>}</string> → 字符串数组
  • @type {import('./types').User} → 引入外部类型定义
  • @typedef {Object} Config <prop> {string} host</prop> → 自定义类型别名

3. 添加类型声明文件(.d.ts)补全缺失类型

第三方库若无类型定义,可手动创建 src/types/global.d.ts(需在 tsconfig.json 的 include 中包含):

// src/types/global.d.ts
declare module 'some-legacy-lib' {
  const value: any;
  export default value;
}
<p>// 或为全局变量声明
declare const <strong>DEV</strong>: boolean;
</p>

也可安装社区维护的类型包:npm install --save-dev @types/react @types/lodash(查 DefinitelyTyped)。

4. 集成到开发与构建流程

在 package.json 中添加脚本:

"scripts": {
  "type-check": "tsc --noEmit",
  "type-check:watch": "tsc --noEmit --watch"
}

配合编辑器(VS Code 开箱即用)实时提示;CI 中运行 npm run type-check 做类型门禁。Webpack/Vite 用户无需改动配置——TypeScript 此时仅做检查,不参与打包。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4186

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1069

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4084

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

840

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1736

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3065

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

3973

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2540

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

828

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 11.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习