# @cedrugs/pdf-parse 中文文档

规范地址：https://npmcn.com/package/%40cedrugs/pdf-parse/

版本：1\.0\.0
npm 元数据更新时间：2025-09-04T16:55:35.338Z
中文译文更新时间：2026-11-09T07:02:57.502Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cedrugs/pdf-parse
原文对照：https://npmcn.com/package/%40cedrugs/pdf-parse/?lang=original
项目主页：https://github.com/Cedrugs/pdf-parse
源码仓库：https://github.com/Cedrugs/pdf-parse

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：24.2 MB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2025-09-04T16:55:34.700Z
- 最新版本发布：2025-09-04T16:55:35.088Z
- 近 30 天下载量：6489（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

带有修正的 pdf- parse 叉

## 安装

```sh
npm install @cedrugs/pdf-parse
```

也可以使用：`pnpm add @cedrugs/pdf-parse`、`yarn add @cedrugs/pdf-parse`、`bun add @cedrugs/pdf-parse`

## README

# @cedrugs/pdf-parse (英语)

**纯JavaScript,跨平台 PDF 文本和元数据提取.**  
维持的叉子 [`pdf-parse`](https://www.npmjs.com/package/pdf-parse) 与 **已捆绑类型脚本**, (中文(简体) ), **有利于无害环境管理的默认出口**,以及 **节点18+** 支助.

[![npm](https://img.shields.io/npm/v/%40cedrugs%2Fpdf-parse.svg)](https://www.npmjs.com/package/@cedrugs/pdf-parse) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://npmcn.com/package/%40cedrugs/pdf-parse/LICENSE) ![node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)

* * *

## 为什么这个叉子?

-   **包括的类型** - 船舶 `index.d.ts` (无需要) `@types/pdf-parse`) (中文(简体) ).
-   **无害环境管理和CJS友好** ——默认导入工程出箱.
-   **相同的 API** 作为倒置的上游.
-   **节点18+** 现代运行时间的最小值.

> 如果你想保持现有的 `import pdf from "pdf-parse"` 使用,参见 **安装( 化名)** 节.

* * *

## 安装

### 选项A——直接使用此范围包

```bash
npm i @cedrugs/pdf-parse
# or
pnpm add @cedrugs/pdf-parse
# or
yarn add @cedrugs/pdf-parse
```

### 选项 B — 通过 npm 化名保留旧的导入名称

```bash
npm i pdf-parse@npm:@cedrugs/pdf-parse
```

现在 `import pdf from "pdf-parse"` 继续工作, 但决心在这个分叉.

* * *

## Basic Usage — 本地文件

### 常见JS

```js
const fs = require('fs');
const pdf = require('@cedrugs/pdf-parse'); // or 'pdf-parse' if using the alias

const dataBuffer = fs.readFileSync('path/to/file.pdf');

pdf(dataBuffer).then((data) => {
    // number of pages
    console.log(data.numpages);
    // number of rendered pages
    console.log(data.numrender);
    // PDF info
    console.log(data.info);
    // PDF metadata
    console.log(data.metadata);
    // PDF.js version
    // see https://mozilla.github.io/pdf.js/getting_started/
    console.log(data.version);
    // PDF text
    console.log(data.text);
});
```

### 无害环境管理/类型脚本

```ts
import pdf from '@cedrugs/pdf-parse'; // default export supported
import { readFileSync } from 'node:fs';

const buf = readFileSync('path/to/file.pdf');
const data = await pdf(buf);

console.log(data.text);
```

* * *

## 基本用途——HTTP

您可以使用软件包 [`crawler-request`](https://www.npmjs.com/package/crawler-request) 与 `pdf-parse`。 。 。 .

* * *

## 例外处理

```js
const fs = require('fs');
const pdf = require('@cedrugs/pdf-parse');

const buf = fs.readFileSync('path/to/file.pdf');

pdf(buf)
    .then((data) => {
        // use data
    })
    .catch((err) => {
        // handle exceptions
        console.error(err);
    });
```

* * *

## 类型脚本

这叉子是自己的 `.d.ts`无外部 `@types/pdf-parse` 需要帮助.

```ts
import pdf from '@cedrugs/pdf-parse';

const res = await pdf(Buffer.from('...'));
res.text;       // string
res.numpages;   // number
res.version;    // "default" | "v1.9.426" | "v1.10.100" | "v1.10.88" | "v2.0.550"
```

* * *

## 选项

```js
const DEFAULT_OPTIONS = {
    // internal page parser callback
    // set this if you need a custom output format instead of raw text
    pagerender: render_page,

    // max page number to parse (<= 0 means “all pages”)
    max: 0,

    // see https://mozilla.github.io/pdf.js/getting_started/
    version: 'v1.10.100'
};
```

### `pagerender` (回电)

自定义每个页面的渲染/提取方式, 如果您需要结构化的输出超过纯文本 .

### `max` (数目)

要解析的最大页数 。 使用 `0` 或分析所有页面的负值.

### `version` (字符串,pdf.js版本)

-   `'default'`
-   `'v1.9.426'`
-   `'v1.10.100'`
-   `'v1.10.88'`
-   `'v2.0.550'`

> 默认版本是 `v1.10.100`见 [pdf.js 开始引导](https://mozilla.github.io/pdf.js/getting_started/)。 。 。 .

* * *

## 扩展- 自定义 `pagerender`

```js
function render_page(pageData) {
    // see https://mozilla.github.io/pdf.js/
    const render_options = {
        // replace all whitespace with standard spaces (0x20)
        normalizeWhitespace: false,
        // do not attempt to combine cedrugse-line TextItems
        disableCombineTextItems: false
    };

    return pageData.getTextContent(render_options).then((textContent) => {
        let lastY;
        let text = '';
        for (const item of textContent.items) {
            if (lastY === item.transform[5] || !lastY) {
                text += item.str;
            } else {
                text += '\n' + item.str;
            }
            lastY = item.transform[5];
        }
        return text;
    });
}

const options = { pagerender: render_page };
const dataBuffer = require('fs').readFileSync('path/to/file.pdf');

require('@cedrugs/pdf-parse')(dataBuffer, options).then((data) => {
    // use custom-formatted output
});
```

* * *

## 类似软件包

-   [pdf2json (英语)](https://www.npmjs.com/package/pdf2json)
-   [j-pdfjson (英语)](https://www.npmjs.com/package/j-pdfjson)
-   [pdf- parser 软件](https://github.com/dunso/pdf-parse)
-   [pdf阅读器](https://www.npmjs.com/package/pdfreader)
-   [pdf 摘录](https://www.npmjs.com/package/pdf-extract)

_(不同的取舍:依赖性,维护,平台支持,以及输出格式_

* * *

## 测试

-   `npm test` (运行) `mocha`(中文(简体) )
-   见 `test` 上游用于使用构想的目录;欢迎在此提供补充测试.

* * *

## 支助/问题

-   **问题:** 在 GitHub 上打开 [https://github.com/Cedrugs/pdf-parse/issues (中文(简体) )](https://github.com/Cedrugs/pdf-parse/issues)
-   **讨论/进度报告:** 欢迎光临!

* * *

## 许可证

[麻省理工学院](https://npmcn.com/package/%40cedrugs/pdf-parse/LICENSE)

### 鸣谢

这个项目是建立在原作者的出色工作基础上的 [`pdf-parse`](https://www.npmjs.com/package/pdf-parse) 以及PDF.js团队.

## 常见问题

### @cedrugs/pdf-parse 是什么？

带有修正的 pdf- parse 叉

### 如何安装 @cedrugs/pdf-parse？

在项目目录运行 npm install @cedrugs/pdf-parse，或使用 pnpm add / yarn add / bun add。

### @cedrugs/pdf-parse 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cedrugs/pdf-parse 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cedrugs/pdf-parse 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cedrugs/pdf-parse 可以商用吗？

@cedrugs/pdf-parse 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cedrugs/pdf-parse 的下载量有多少？

根据 npm 官方下载统计，@cedrugs/pdf-parse 在 2026/10/10 – 2026/11/08 这 30 天内被下载 6,489 次，日均约 216 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cedrugs/pdf-parse 还在维护吗？

最新版本 1\.0\.0 发布于 2025/09/05（1\.2 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/09/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。