1.0.4 • Published 5 months ago
psg-pdf v1.0.4
image-to-pdf
A Node.js package to convert images (PNG, JPG, JPEG) to PDF using TypeScript and pdfkit.
Installation
npm install psg-pdf
Usage
TypeScript
import imageToPdf from 'psg-pdf';
async function convertImageToPdf(imagePath: string, outputPath: string) {
try {
await imageToPdf(imagePath, outputPath);
console.log(`Image converted to PDF successfully at ${outputPath}`);
} catch (error) {
console.error('Error converting image to PDF:', error);
}
}
// Example usage:
async function main() {
await convertImageToPdf('path/to/your/image.png', 'output.pdf'); // Example for PNG
await convertImageToPdf('path/to/your/image.jpg', 'output.pdf'); // Example for JPG
await convertImageToPdf('path/to/your/image.jpeg', 'output.pdf'); // Example for JPEG
}
main();
API
imageToPdf(imagePath: string, outputPath: string)
: Promise Converts an image to a PDF file.imagePath
: The path to the input image file (PNG, JPG, or JPEG). outputPath: The path to save the output PDF file. Throws:Error
: If the image format is unsupported or if there is an error during conversion. BMP files are not supported; convert them to PNG or JPG first.Supported Image Formats
PNG JPG JPEG
Error Handling
The imageToPdf function throws an Error if there's a problem during the conversion process. Make sure to wrap the function call in a try...catch block to handle potential errors.
TypeScript
import imageToPdf from 'image-to-pdf';
async function convert() {
try {
await imageToPdf('path/to/your/image.png', 'output.pdf');
console.log('Conversion complete!');
} catch (error) {
console.error('Error during conversion:', error);
}
}
convert();
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
MIT
Author
Muhammad Zohaib Hasan