Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dichovsky/pdf-to-png-converter
Library Convert PDF to PNG
https://github.com/dichovsky/pdf-to-png-converter
Last synced: 3 months ago
JSON representation
Library Convert PDF to PNG
- Host: GitHub
- URL: https://github.com/dichovsky/pdf-to-png-converter
- Owner: dichovsky
- License: mit
- Created: 2021-08-24T18:14:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T19:41:12.000Z (6 months ago)
- Last Synced: 2024-07-19T21:31:55.345Z (4 months ago)
- Language: TypeScript
- Size: 72.8 MB
- Stars: 98
- Watchers: 4
- Forks: 22
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pdf-to-png-converter
Node.js utility to convert PDF file/buffer pages to PNG files/buffers without binary and OS dependencies (except MacOs on arm64).
[](https://github.com/dichovsky/pdf-to-png-converter/actions/workflows/test.yml)
## Getting started
### MacOs M1 prerequisites
MacOs M1 dependencies prerequisites installation
```bash
arch -arm64 brew install pkg-config cairo pango libpng librsvg
```
### Package installation
Installation:
```sh
npm install -D pdf-to-png-converter
```
## Example
```javascript
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.
enableXfa: false, // Render Xfa forms if any. 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.
verbosityLevel: 0 // Verbosity level. ERRORS: 0, WARNINGS: 1, INFOS: 5. Default value is 0.
});
...
});
```
## Output
```javascript
{
pageNumber: number; // Page number in PDF file
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)
width: number; // PNG page width
height: number; // PNG page height
}
```
## Buy Me A Coffee
In case you want support my work
[](https://buymeacoffee.com/dichovsky)