在 TypeScript 代码上启用的基本标志

介绍

typescript 是一个强大的工具，它将静态类型引入 javascript，为构建可扩展和可维护的应用程序提供了坚实的基础。为了最大限度地发挥 typescript 的优势，启用某些增强类型安全性和代码质量的编译器选项标志至关重要。在本文中，我们将探讨您应该在 typescript 项目中启用的五个基本标志，以及它们如何帮助您编写更好的代码。

初始设置

在本文中，我们将介绍 typescript 标志：noimplicitany、strictnullchecks、strictpropertyinitialization、noimplicitreturns 和 nounusedparameters。要启用每个标志，您需要更新 tsconfig.json 文件，将这些标志设置为 true，如下例所示：

{
  "compileroptions": {
    // ...other configurations
    "noimplicitany": true,
    "strictnullchecks": true,
    "strictpropertyinitialization": true,
    "noimplicitreturns": true,
    "nounusedparameters": true
  }
}

1.避免使用“any”类型

• 标志： noimplicitany
• 描述： noimplicitany 标志确保您显式声明类型而不是默认为 any 类型。这可以防止非类型化变量渗入您的代码库，从而增强类型安全性。
• 专业提示： 不要使用任何类型，而是利用未知类型。要检查变量是否属于您想要的类型，请使用类型防护。如果您不熟悉类型防护，请查看这篇文章：使用类型防护提升您的 typescript 技能。这种做法可以强制执行更好的类型检查并减少运行时错误。

当您启用 noimplicitany 时，typescript 每当推断出 any 时都会发出错误：

function fn(s) {
  // type error: parameter 's' implicitly has an 'any' type.
  console.log(s.subtr(3));
}

2.启用严格的空检查

• 标志： strictnullchecks
• 描述： 启用 strictnullchecks 可确保 null 和 undefined 只能分配给各自的类型。这可以防止与空值相关的常见陷阱并提高代码可靠性。
• 专业提示： 使用可选链接 (?.) 和空值合并 (??) 运算符来优雅地处理 null 和未定义值。

如果您尝试使用未经适当检查而可能为 null 或未定义的变量，则将 strictnullchecks 设置为 true 将引发错误：

declare const loggedinusername: string;

const users = [
  { name: "oby", age: 12 },
  { name: "heera", age: 32 },
];

const loggedinuser = users.find((u) => u.name === loggedinusername);
// type error: 'loggedinuser' is possibly 'undefined'.
console.log(loggedinuser.age);

3. 强制执行严格的属性初始化

• 标志： strictpropertyinitialization
• 描述： strictpropertyinitialization 标志确保所有类属性都在构造函数中初始化或使用默认值初始化。这有助于在开发过程的早期捕获未初始化的属性。
• 专业提示： 当您确定属性在访问时将被初始化时，请使用明确的赋值断言（！）。

设置为 true 时，当声明类属性但未在构造函数中设置时，typescript 将引发错误：

class useraccount {
  name: string;
  accounttype = "user";
  // type error: property 'email' has no initializer and is not definitely assigned in the constructor.
  email: string;

  constructor(name: string) {
    this.name = name;
    // note that this.email is not set
  }
}

4.启用noimplicitreturns

• 标志： noimplicitreturns
• 描述： noimplicitreturns 标志确保函数中的所有代码路径都返回一个值。这有助于捕获函数可能意外返回未定义或根本没有值的逻辑错误。
• 专业提示： 检查您的函数以确保它们具有一致的返回语句，从而提供清晰且可预测的数据流。

启用后，typescript 将检查函数中的所有代码路径以确保它们返回一个值：

// type error: function lacks ending return statement and return type does not include 'undefined'.
function lookupheadphonesmanufacturer(color: "blue" | "black"): string {
  if (color === "blue") {
    return "beats";
  } else {
    ("bose");
  }
}

5.启用nounusedlocals和nounusedparameters

• 标志： nounusedlocals、nounusedparameters
• 描述：这些标志通过报告未使用的局部变量和参数来帮助您维护干净的代码库。这减少了混乱并使代码更具可读性。
• 专业提示：定期检查和重构您的代码以删除未使用的变量和参数，保持您的代码库干净和高效。

这些标志将报告未使用的变量和参数的错误，帮助您保持代码整洁：

// Type Error: 'modelID' is declared but its value is never read.
const createDefaultKeyboard = (modelID: number) => {
  const defaultModelID = 23;
  return { type: "keyboard", modelID: defaultModelID };
};

结论

启用这些基本的 typescript 标志不仅可以增强类型安全性，还可以促进最佳实践和代码可维护性。通过利用 typescript 强大的类型系统和编译器选项，您可以编写更健壮、更可靠的代码，最终带来更流畅的开发体验。

通过将这些标志和最佳实践合并到您的 typescript 项目中，您将能够很好地编写更干净、更安全、更易于维护的代码。而你，在 typescript 代码中使用的标志是什么？