Package Exports

compress-pdf
compress-pdf/dist/index.js
compress-pdf/dist/index.mjs

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 (compress-pdf) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

compress-pdf

This library provides compress your PDFs using ghostscript

Installation

npm install compress-pdf

yarn add compress-pdf

🚨 Install binaries

Ubuntu

sudo apt-get install ghostscript -y

MacOS

brew install ghostscript

Windows (Chocolatey)

choco install ghostscript

or download Ghostscript .exe installer

Code Usage

import path from 'path';
import fs from 'fs';
import { compress } from 'compress-pdf';

(async () => {
  const pdf = path.resolve(__dirname, 'A17_FlightPlan.pdf');
  const buffer = await compress(pdf);

  const compressedPdf = path.resolve(__dirname, 'compressed_pdf.pdf');
  await fs.promises.writeFile(compressedPdf, buffer);
})();

CLI Usage

npx compress-pdf --file [PDF_FILE] --output ./compressed.pdf

Options:
  --file [PDF_FILE] (REQUIRED)
  --output [COMPRESSED_PDF_FILE] (REQUIRED)
  --resolution [ebook/printer/screen/prepress]
  --compatibilityLevel [NUMBER] The compatibility pdf level
  --gsModule [FILE PATH] The directory of ghostscript binaries. Ex: /usr/bin/gs

Usage with Docker

FROM node:18 AS build
WORKDIR /src
COPY package*.json ./
RUN npm pkg set scripts.scriptname="true" && npm i
COPY . .
RUN npm run build

FROM node:18
WORKDIR /app
RUN apt-get update \
    && apt-get install -y ghostscript
COPY package*.json ./
RUN npm pkg set scripts.scriptname="true" && npm i
COPY --from=build /src/build /app/build/
EXPOSE 8080
CMD [ "npm", "start" ]

OBS: This is just an example of how to use this lib in a docker image, note that you need to run apt-get to install ghostscript before doing anything

You can see examples in examples folder

License

This project is under MIT license, see LICENSE.md for details.