2.0.2 • Published 10 months ago

@mmaaikel/pdf-parse v2.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

@mmaaikel/pdf-parse

Pure javascript cross-platform module to extract texts from PDFs.

Similar Packages

Based on

https://gitlab.com/autokent/pdf-parse

Installation

npm install @mmaaikel/pdf-parse

Basic Usage - Local Files

import fs from 'fs'
import PdfParse from '@mmaaikel/pdf-parse'

let dataBuffer = fs.readFileSync('path to PDF file...');

PdfParse(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); 
        
});

Exception Handling

import fs from 'fs'
import PdfParse from '@mmaaikel/pdf-parse'

let dataBuffer = fs.readFileSync('path to PDF file...');

PdfParse(dataBuffer).then(function(data) {
	// use data
})
.catch(function(error){
	// handle exceptions
})

Options

const DEFAULT_OPTIONS = {
	// internal page parser callback
	// you can set this option, if you need another format except raw text
	pageRender: render_page,
	
	// max page number to parse
	max: 0,
	
	//check https://mozilla.github.io/pdf.js/getting_started/
	version: 'v1.10.100'
}

pageRender (callback)

If you need another format except raw text.

max (number)

Max number of page to parse. If the value is less than or equal to 0, parser renders all pages.

version (string, pdf.js version)

check pdf.js

  • 'default'
  • 'v1.9.426'
  • 'v1.10.100'
  • 'v1.10.88'
  • 'v2.0.550'

default version is v1.10.100
mozilla.github.io/pdf.js

Test

Support

I use this package actively myself, so it has my top priority. You can chat on WhatsApp about any infos, ideas and suggestions.

WhatsApp

Submitting an Issue

If you find a bug or a mistake, you can help by submitting an issue to GitLab Repository

Creating a Merge Request

GitLab calls it merge request instead of pull request.

License

MIT licensed and all it's dependencies are MIT or BSD licensed.