在TypeScript项目中使用pdf2json(3.0.1)遇类型声明文件缺失问题求助

当pdf2json没有官方类型包时，有几种实用的解决方式：

1. 手动创建自定义声明文件 #

这是最规范的长期解决方案，能获得完整的类型提示：

• 在项目的src目录下新建types/pdf2json文件夹，再创建index.d.ts文件
• 在文件中写入基础的模块声明（可根据实际使用的API补充更多定义）：

declare module 'pdf2json' {
  import { EventEmitter } from 'events';

  class PDFParser extends EventEmitter {
    constructor();
    loadPDF(pdfFilePath: string): void;
    on(event: 'pdfParser_dataError', listener: (err: Error) => void): this;
    on(event: 'pdfParser_dataReady', listener: (pdfData: Record<string, any>) => void): this;
  }

  export = PDFParser;
}

• 修改tsconfig.json，让TypeScript识别自定义类型目录：

{
  "compilerOptions": {
    "typeRoots": ["./node_modules/@types", "./src/types"]
  }
}

2. 临时忽略类型错误 #

如果只是快速开发，不想花时间写声明文件，可以在导入时添加注释跳过类型检查：

// @ts-ignore
import PDFParser from 'pdf2json';

注意：这种方式没有类型提示，仅适合临时场景，不推荐在生产项目中长期使用。

3. 检查包内是否自带声明文件 #

部分npm包会自行包含类型文件，先查看node_modules/pdf2json目录下是否有.d.ts文件。如果存在，可能是tsconfig.json的include配置未覆盖到该文件，调整include范围即可：

{
  "include": ["src/**/*", "node_modules/pdf2json/**/*.d.ts"]
}

内容的提问来源于stack exchange，提问作者Javier