使用 TypeScript 来编写 JavaScript 项目

在一般的代码中,TypeScript 中的类型系统的严格程度是不一样的:

  • 只基于 JavaScript 代码推断
  • 增强的 JavaScript 类型推断(通过 JSDoc
  • 在 JavaScript 文件里面使用 // @ts-check
  • TypeScript 代码
  • TypeScript 的 strict 模式

每一步都代表着向更安全的类型系统迈进,但并不是每个项目都需要级别最高的验证。

TypeScript 与 JavaScript

某些编辑器会使用 TypeScript 来提供帮助,如自动补全,跳转到特定位置。此外还可以帮助重构,如重命名。主页有一个编辑器列表,该列表中的编辑器包含 TypeScript 插件。

通过 JSDoc 在 JS 中提供类型提示

.js 文件里,类型通常可以被推断出来。当无法推断类型时,可以使用 JSDoc 语法来指定。

位于声明语句之前的 JSDoc 注释,将用于设置该声明的类型。例如:

js
/** @type {number} */
var x;
 
x = 0; // OK
x = false; // OK?!
Try

你可以在 JSDoc 支持的类型列表找到受支持的 JSDoc 语法的完整说明。

@ts-check

上述代码示例的最后一行在 TypeScript 中会引发错误,但在 JS 项目中,默认情况下不会引发错误。要使 JavaScript 文件显示错误,请在 .js 文件的第一行中添加: // @ts-check

js
// @ts-check
/** @type {number} */
var x;
 
x = 0; // OK
x = false; // Not OK
Type 'boolean' is not assignable to type 'number'.2322Type 'boolean' is not assignable to type 'number'.
Try

如果你有许多 JavaScript 文件要显示错误,则可以使用 jsconfig.json 来代替注释。你可以通过在文件中添加 // @ts-nocheck 注释来跳过检查某些文件。

TypeScript 可能会提供一些你不想看到的错误,在这种情况下,你可以通过在某一行的前一行添加 // @ts-ignore// @ts-expect-error 来忽略该行上的错误。

js
// @ts-check
/** @type {number} */
var x;
 
x = 0; // OK
// @ts-expect-error
x = false; // Not OK
Try

要详细了解 TypeScript 如何解释 JavaScript,请阅读 TS 是如何检查 JS 的

The TypeScript docs are an open source project. Help us improve these pages by sending a Pull Request

Contributors to this page:
  (6)

Last updated: 2024年11月22日