# @vtfk/pdf-text-reader

> Pdf reader

Latest version **1.1.3** (published 2025-01-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vtfk/pdf-text-reader
pnpm add @vtfk/pdf-text-reader
yarn add @vtfk/pdf-text-reader
bun add @vtfk/pdf-text-reader
```

## Health

**Score 40/100 (D)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2025-01-16 |
| First published | 2021-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 92 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | jorgtho |
| Maintainers | runely, jorgtho |
| Keywords | pdf, reader |

## Links

- npm: https://www.npmjs.com/package/@vtfk/pdf-text-reader
- Repository: https://github.com/vtfk/pdf-text-reader
- Homepage: https://github.com/vtfk/pdf-text-reader#readme
- Issues: https://github.com/vtfk/pdf-text-reader/issues
- npm.io page: https://npm.io/package/@vtfk/pdf-text-reader

## Dependencies (3)

- [webpack](https://npm.io/package/webpack.md) ^5.39.0
- [pdfjs-dist](https://npm.io/package/pdfjs-dist.md) ^4.10.38
- [worker-loader](https://npm.io/package/worker-loader.md) ^3.0.8

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.1.3 (latest) — 2025-01-16
- 1.1.2 — 2022-03-31
- 1.1.1 — 2022-03-29
- 1.1.0 — 2022-03-28
- 1.0.4 — 2022-01-07
- 1.0.3 — 2021-11-02
- 1.0.1 — 2021-06-17

## README

# pdf-text-reader
Exctracts metadata, text, and styling from a pdf-file

## Installation
```bash
npm i @vtfk/pdf-text-reader
```
## Usage
```js
(async () => {
  const pdfReader = require('./index')
  
  const pdfPath = './data/examplePdf.pdf'
  try {
    const pdfData = await pdfReader(pdfPath)
    console.log(pdfData)
  } catch (error) {
    console.log(error)
  }
})()
```

returns:
```js
{
    metadata: {'some metadata about pdf'},
    textContent: [
        {
            str: 'Hello',
            dir: 'ltr',
            width: 6.87792,
            height: 11.04,
            transform: [
                8.87003171296,
                0,
                0,
                9.00064,
                87.8488,
                401.468
            ],
            fontName: 'g_d1_f1',
            page: 1
        },
        ...
    }
}
```
## Options
### InferLines

normalizeY is set to 300 by default

```js
(async () => {
  const pdfReader = require('./index')
  
  const pdfPath = './data/examplePdf.pdf'
  try {
    const options = {
        inferLines: {
            normalizeY: true // can be true, a number, false, or undefined
        }
    }
    const pdfData = await pdfReader(pdfPath, options)
    console.log(pdfData)
  } catch (error) {
    console.log(error)
  }
})()
```
returns:
```js
{
    metadata: {'some metadata about pdf'},
    textContent: [
        {
            str: 'Hello',
            dir: 'ltr',
            width: 6.87792,
            height: 11.04,
            transform: [
                8.87003171296,
                0,
                0,
                9.00064,
                87.8488,
                401.468
            ],
            fontName: 'g_d1_f1',
            page: 1
        },
        ...
    },
    lines: {
        '300': 'Hello , this is the first l ine'
    }
}
```

---
_Source: https://npm.io/package/@vtfk/pdf-text-reader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._