# @deeptakirandas/pdf-parse

> Pure javascript cross-platform module to extract text from PDFs.

Latest version **1.1.4** (published 2022-02-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @deeptakirandas/pdf-parse
pnpm add @deeptakirandas/pdf-parse
yarn add @deeptakirandas/pdf-parse
bun add @deeptakirandas/pdf-parse
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2022-02-05 |
| First published | 2022-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.8.1 |
| Dependencies | 2 |
| Unpacked size | 28 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Deepta Kiran Das |
| Maintainers | deeptakirandas |
| Keywords | pdf-parse, pdf-crawler, xpdf, pdf.js, pdfreader, pdf-extractor, pdf2json, j-pdfjson, pdf-parser, pdf-extract, pdf-extractor, pdf-to-text, pdf-text-extract, pdfjs, server side PDF parsing, pdf metadata |

## Links

- npm: https://www.npmjs.com/package/@deeptakirandas/pdf-parse
- Repository: https://github.com/Deepta-Das/pdf-parser
- Homepage: https://github.com/Deepta-Das/pdf-parser#readme
- Issues: https://github.com/Deepta-Das/pdf-parser/issues
- npm.io page: https://npm.io/package/@deeptakirandas/pdf-parse

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [node-ensure](https://npm.io/package/node-ensure.md) ^0.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.4 (latest) — 2022-02-05
- 1.1.3 — 2022-01-28
- 1.1.2 — 2022-01-27

## README

# @deeptakirandas/pdf-parse

**Javascript cross-platform module to extract texts from PDFs.**

## Installation
`npm i @deeptakirandas/pdf-parse`
 
## Basic Usage - Local Files

```js
const fs = require('fs');
const pdf = require('@deeptakirandas/pdf-parse');

let dataBuffer = fs.readFileSync('path to PDF file...');

pdf(dataBuffer).then(function(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
	// check https://mozilla.github.io/pdf.js/getting_started/
	console.log(data.version);
	// PDF text
	console.log(data.text); 
        
});
```

## Basic Usage - HTTP
You can use [crawler-request](https://www.npmjs.com/package/crawler-request) which uses the `pdf-parse`

## Exception Handling

```js
const fs = require('fs');
const pdf = require('@deeptakirandas/pdf-parse');

let dataBuffer = fs.readFileSync('path to PDF file...');

pdf(dataBuffer).then(function(data) {
	// use data
})
.catch(function(error){
	// handle exceptions
})
```


## License
[MIT licensed](https://github.com/Deepta-Das/pdf-parser/blob/main/LICENSE) and all it's dependencies are MIT

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