html-pdf-converter-node v2.1.1
HTML to PDF Exporter
A simple Node.js package that converts HTML content to a PDF and saves it to a specified folder. Once saved, the PDF can be accessed via a URL.
Installation
To use the html-to-pdf-exporter package, follow these steps:
1. Install the required dependencies
This package relies on html-pdf-node for PDF generation and dotenv to manage environment variables.
Run the following command to install the necessary packages:
npm install html-pdf-node dotenv
2. Install the package
If you're using it as a standalone package, install it via NPM:npm install html-to-pdf-exporter
you just have to import convertHTMLTOPDF from "html-pdf-converter-node"
const convertHTMLTOPDF = require("html-pdf-converter-node")
let htmlContent = `<!DOCTYPE html>
<html>
<title>HTML Tutorial</title>
<body>
<h1>This is a heading</h1>
<p>This is a paragraph.</p>
</body>
</html>`const onSuccess = async (url) => {
console.log(url)
// here you will get pdf url and it will be saved in your provided path.
};
const onError = async (error) => {
console.error("Error generating PDF:", error);
// here you will get error while processing html to pdf.
};
const pdfResponse = await convertHTMLTOPDF(htmlContent,"fileName","folder",onSuccess,onError)- Create a .env file At the root of your project, create a .env file to define the URL where the generated PDFs will be accessible.
Example .env file:
env Copy NODE_PDF_URL=http://yourdomain.com/pdf Replace http://yourdomain.com/pdf with the URL where your PDFs will be served from.
Environment Variables Make sure to set the following environment variable in your .env file:
NODE_PDF_URL: The base URL where the generated PDF files will be accessible.
Expected Output: If successful, the callback onSuccess will receive a URL pointing to the generated PDF file:
Error Handling The convertHTMLTOPDF function has built-in error handling. You can provide an onError callback to handle any issues, such as:
Invalid HTML content File write permission errors PDF generation issues
Folder Setup The folder specified in folderName must either exist or be created by the script. If it doesn't exist, ensure you have appropriate file permissions to create it on the server.
Additional Notes: File Paths: The generated PDF will be saved on the server in the folder specified in folderName. The URL to access the PDF will be constructed using the environment variable NODE_PDF_URL.