TypeScript Academy · 课时

处理无类型的第三方库

使用 @types 包并手动编写声明

第 4 / 4 课13 个步骤

处理无类型的第三方库 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 4 节课。

问题:缺少类型

有些 npm 软件包不会提供 TypeScript 声明,也没有对应的 @types/ 软件包。TypeScript 默认会将它们视为 any,从而失去边界处的类型安全性。

import legacyLib from "untyped-lib"; // legacyLib: any

@types 软件包

DefinitelyTyped 项目为数千个库提供由社区维护的类型声明。请在 npm 中搜索 @types/library-name。

npm install --save-dev @types/lodash
npm install --save-dev @types/express
# Now lodash and express have full TypeScript types

编写声明文件(.d.ts)

如果不存在 @types 软件包,请在项目中编写一个最小声明文件,声明该模块及其类型。

// src/types/untyped-lib.d.ts
declare module "untyped-lib" {
  export function doSomething(x: string): number;
  export const version: string;
}

模块增强

通过向现有模块添加自定义声明来扩展已有的第三方类型,而无需派生新的模块。

// Extend Express Request with a custom property
declare namespace Express {
  interface Request {
    user?: AuthUser;
  }
}

通配符模块声明

对于整类没有类型的导入内容(例如资源文件),请使用通配符模块声明。

// src/types/assets.d.ts
declare module "*.svg" {
  const content: string;
  export default content;
}
declare module "*.json" {
  const value: Record<string, unknown>;
  export default value;
}

noImplicitAny 与无类型库

启用 noImplicitAny: true 后,导入没有类型的模块会导致编译错误。请使用声明文件,或通过 // @ts-ignore 按文件禁用 noImplicitAny。

// Quick fix for a single untyped import:
// @ts-ignore
import untypedLib from "untyped-lib";

为 DefinitelyTyped 做贡献

如果您为一个没有类型的库编写了高质量类型,请将其提交到 DefinitelyTyped,帮助社区改进类型支持。

# Fork DefinitelyTyped and add:
# types/your-library/index.d.ts
# types/your-library/package.json
# Submit a PR at github.com/DefinitelyTyped/DefinitelyTyped

将 any 作为最后手段

如果无法及时获得类型,请使用明确的 any,并通过注释跟踪这项技术债务。这比隐式 any 更好,因为它是有意为之且清晰可见的。

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const lib: any = require("untyped-lib"); // TODO: add types

使用 skipLibCheck 处理声明错误

如果第三方 .d.ts 文件内部存在错误,skipLibCheck: true 可以将其抑制,而不会影响您自己的类型检查。

{
  "compilerOptions": {
    "skipLibCheck": true
  }
}

为不安全库编写类型包装器

围绕没有类型的库编写一个带类型的包装模块,将 any 限制在其中,并向代码库的其余部分提供安全的类型化 API。

// src/lib/safe-legacy.ts
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const raw: any = require("untyped-lib");
export function doSomething(x: string): number { return raw.doSomething(x); }

回顾:无类型库

处理没有类型的库:先检查 @types/ 软件包,编写最小声明文件,使用模块增强,创建带类型的包装器,并使用 skipLibCheck 处理依赖项中的声明错误。

快速检查

为没有类型的 npm 软件包查找类型声明时,首先应该去哪里?

您学到的内容

没有类型的库:检查 @types/ 软件包,编写声明文件,增强现有类型,使用通配符模块声明,用带类型的外观包装不安全的库,并使用 skipLibCheck 处理依赖项错误。

免费开始

用 AI 导师学习 TypeScript — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
101
课程
352

常见问题解答

「处理无类型的第三方库」课时是免费的吗?

是的 — 「处理无类型的第三方库」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 TypeScript Academy 课程的其余内容,请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 4 节课。

「处理无类型的第三方库」这节课中我会学到什么?

使用 @types 包并手动编写声明 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 TypeScript Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。

「处理无类型的第三方库」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 TypeScript Academy 课中编写并运行代码吗?

能。每节 TypeScript Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 开始迁移:allowJs 与 checkJs
  2. JSDoc 类型注解:过渡方案
  3. 逐文件转换策略
  4. 处理无类型的第三方库
← 返回 TypeScript Academy