Skip to content

rodrigobdz/pdfoptim

Repository files navigation

pdfoptim Build Status

Optimize file size of PDFs

Install

$ npm install pdfoptim

Usage

const pdfoptim = require('pdfoptim');

pdfoptim('printer-manual.pdf');
// Filesize difference -79.46% ✂️
// Optimized version of printer-manual.pdf saved as optimized-1556039930343.pdf 🎉

API

pdfoptim(filePath, [options])

filePath

Type: string

Path to PDF file to optimize.

options

Type: Object

outputFile

Type: string
Default: optimized-{timestamp}.pdf

Filename for optimized PDF.

CLI

$ npm install --global pdfoptim
$ pdfoptim --help

  Usage
    pdfoptim [filePath]

  Options
    --outputFile  File name for optimized PDF [Default: optimized-{timestamp}.pdf

  Examples
    $ pdfoptim essay.pdf
    // Optimized PDF created with name optimized-[timestamp].pdf
    $ pdfoptim -o optim-essay.pdf essay.pdf
    // Optimized PDF created with name essay-optim.pdf

Credits

License

MIT © Rodrigo Bermudez Schettino