JSPM

  • Created
  • Published
  • Downloads 40709
  • Score
    100M100P100Q154572F
  • License MIT

Node.js utility to convert PDF file/buffer pages to PNG files/buffers with no native dependencies.

Package Exports

  • pdf-to-png-converter
  • pdf-to-png-converter/out/index.js

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

Readme

pdf-to-png-converter

Node.js utility to convert PDF file/buffer pages to PNG files/buffers without binary and OS dependencies.

Tests on push

Getting started

Installation:

npm install -D pdf-to-png-converter

Example

test(`Convert PDF To PNG`, async () => {
    const pngPages: PngPageOutput[] = await pdfToPng(pdfFilePath, // The function accepts PDF file path or a Buffer
    { 
        disableFontFace: false, // When `false`, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. Default value is true.
        useSystemFonts: false, // When `true`, fonts that aren't embedded in the PDF document will fallback to a system font. Default value is false.
        viewportScale: 2.0, // The desired scale of PNG viewport. Default value is 1.0.
        outputFolder: 'output/folder', // Folder to write output PNG files. If not specified, PNG output will be available only as a Buffer content, without saving to a file.
        outputFileMask: 'buffer', // Output filename mask. Default value is 'buffer'.
        pdfFilePassword: 'pa$$word', // Password for encrypted PDF.
        pagesToProcess: [1, 3, 11],   // Subset of pages to convert (first page = 1), other pages will be skipped if specified.
        strictPagesToProcess: false // When `true`, will throw an error if specified page number in pagesToProcess is invalid, otherwise will skip invalid page. Default value is false.
    });

   ...
});

Output

{
    name: string; // PNG page name in a format `{pdfFileName}_page_{pdfPageNumber}.png`,
    content: Buffer; // PNG page Buffer content
    path: string; // Path to the rendered PNG page file (empty string and if outputFilesFolder is not provided)
};