Package Exports
- pdf-parse
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pdf-parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
pdf-parse
A Pure javascript cross-platform module to extract texts from PDFs.
Similar Packages
- pdf2json buggy, no support anymore, memory leak, throws non-catchable fatal errors.
- j-pdfjson fork of pdf2json.
- pdf-parser buggy, no tests.
- pdfreader using pdf2json.
- pdf-extract not cross-platform using xpdf.
Installation
npm install pdf-parse
Basic Usage - Local Files
const fs = require('fs');
const pdf = require('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 which uses the
pdf-parse
Exception Handling
const fs = require('fs');
const pdf = require('pdf-parse');
let dataBuffer = fs.readFileSync('path to PDF file...');
pdf(dataBuffer).then(function(data) {
// use data
})
.catch(function(error){
// handle exceptions
})
Extend
- If you need another format like json, you can change page render behaviour with a callback.
- Check out https://mozilla.github.io/pdf.js/
function render_page(pageData, ret) {
//check documents https://mozilla.github.io/pdf.js/
ret.text = ret.text ? ret.text : "";
let render_options = {
//replaces all occurrences of whitespace with standard spaces (0x20).
normalizeWhitespace: true,
//do not attempt to combine same line TextItem's.
disableCombineTextItems: false
}
return pageData.getTextContent(render_options)
.then(function(textContent) {
let strings = textContent.items.map(item => item.str);
let text = strings.join(' ');
ret.text = `${ret.text} ${text} \n\n`;
});
}
let options = {
pagerender: render_page
}
let dataBuffer = fs.readFileSync('path to PDF file...');
pdf(dataBuffer,options).then(function(data) {
//use new format
});
Options
Default 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.9.426'
}
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.88'
** default uses version v1.9.426**
** v1.9.426 is stable, v1.10.88 is beta**
Test
mocha
or npm test
check test folder and QUICKSTART.js for extra usage.
Support
I use this package actively myself, so it has my top priority.
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.
Contact me on WhatsApp
For discussing about the package.
License
MIT licensed and all it's dependencies are MIT or BSD licensed.