New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

pdf-thumbnail

Package Overview
Dependencies
Maintainers
2
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pdf-thumbnail

pdf-thumbnail creates a thumbnail of the first page of a pdf file

  • 1.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
744
decreased by-81.26%
Maintainers
2
Weekly downloads
 
Created
Source

pdf-thumbnail

NPM version Downloads Dependency Status

Installation

$ npm i pdf-thumbnail

Getting started

This module works with gm, so you have to install imagemagick and ghostscript on your pc.

On Mac OS X:

$ brew install imagemagick
$ brew install ghostscript

On Linux:

$ sudo apt-get install imagemagick
$ sudo apt-get install ghostscript

What is pdf-thumbnail?

pdf-thumbnail creates a thumbnail of the first page of a pdf file. You can also manipulate the image:

  • You can resize it
  • You can compress it with less quality
  • You can crop it

How to use it

pdf-thumbnail returns a Promise:

const pdf = require('pdf-thumbnail');
const pdfBuffer = require('fs').readFileSync('/some/path/example.pdf');

pdf(
  pdfBuffer, /*Buffer or stream of the pdf*/
  options
)
  .then(data /*Stream of the image*/ => {
    // ...
  })
  .catch(err => console.log(err))

Options

An object where you can put the operations you would like to do on the thumbnail. The current available operations are:

  • Compress
  • Crop
  • Resize
Compress
const pdf = require('pdf-thumbnail');
const pdfBuffer = require('fs').readFileSync('/some/path/example.pdf');

pdf(pdfBuffer, {
  compress: {
    type: 'JPEG',  //default
    quality: 70    //default
  }
})
  .then(data => {
    // ...
  })
  .catch(err => console.log(err))
Crop
const pdf = require('pdf-thumbnail');
const pdfBuffer = require('fs').readFileSync('/some/path/example.pdf');

pdf(pdfBuffer, {
  crop: {
    width: 200,
    height: 400,
    x: 0,
    y: 0
  }
})
  .then(data => {
     // ...
  })
  .catch(err => console.log(err))

If you want to crop the image keeping the aspect ratio, yuo have to add another key to the object:

crop: {
  width: 200,
  height: 400,
  x: 0,
  y: 0,
  ratio: true  //default true
 }
Resize
const pdf = require('pdf-thumbnail');
const pdfBuffer = require('fs').readFileSync('/some/path/example.pdf');

pdf(pdfBuffer, {
  resize: {
    width: 200,   //default
    height: 200,  //default
  }
})
  .then(data => {
    // ...
  })
  .catch(err => console.log(err))

Example

See a few examples here

People

License

MIT

FAQs

Package last updated on 10 Jan 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc