Negotiable Paleobotanist Missions

npm

Need private packages and team management tools?Check out npm Orgs. »

@touno-io/pdf

1.2.0 • Public • Published

@touno-io/pdf

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

version downloads node status

Similar Packages

Installation

npm install @touno-io/pdf

Basic Usage - Local Files

const fs = require('fs')
const pdf = require('@touno-io/pdf')
 
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 @touno-io/pdf

Exception Handling

const fs = require('fs')
const pdf = require('@touno-io/pdf')
 
let dataBuffer = fs.readFileSync('path to PDF file...')
 
pdf(dataBuffer).then(function(data) {
    // use data
})
.catch(function(error){
    // handle exceptions
})

Extend

// default render callback
function render_page(pageData) {
    //check documents https://mozilla.github.io/pdf.js/
    let render_options = {
        //replaces all occurrences of whitespace with standard spaces (0x20). The default value is `false`.
        normalizeWhitespace: false,
        //do not attempt to combine same line TextItem's. The default value is `false`.
        disableCombineTextItems: false
    }
 
    return pageData.getTextContent(render_options)
    .then(function(textContent) {
        let lastY, text = ''
        for (let item of textContent.items) {
            if (lastY == item.transform[5] || !lastY){
                text += item.str
            }  
            else{
                text += '\n' + item.str
            }    
            lastY = item.transform[5]
        }
        return text
    })
}
 
let options = {
        pagerender: render_page,
        pwd: 'password'
}
 
let dataBuffer = fs.readFileSync('path to PDF file...')
 
pdf(dataBuffer, options).then(function(data) {
    //use new format
})

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.10.100'
  • 'v2.0.550'

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

Test

License

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

install

npm i @touno-io/pdf

Downloadsweekly downloads

4

version

1.2.0

license

MIT

homepage

gitlab.com

repository

Gitgitlab

last publish

collaborators

  • avatar
Report a vulnerability