Starlight PDF Module Usage

Introduction: Starlight PDF is a utility module for working with PDF files. It allows you to convert PDF pages into images and convert images back into a PDF.

This module is useful for:

• PDF previews
• PDF editing pipelines
• Image-based PDF manipulation

Importing the Module

To use the PDF utilities, import the module as follows: import PDF from "starlight-pdf"

Available Functions

1. pdfToImages pdfToImages(pdfPath, outputDir)

Converts every page of a PDF file into PNG images.

Parameters:

• pdfPath: string, path to the input PDF file
• outputDir: string, directory where images will be saved

Behavior:

• Each page is rendered as a high-quality PNG image
• Images are named sequentially (page-1.png, page-2.png, ...)
• The output directory is created automatically if it does not exist

Returns: An array of image file paths in page order

2. imagesToPdf

imagesToPdf(imagePaths, outputPdf)

Creates a PDF file from a list of images.

Parameters:

• imagePaths: array of image file paths
• outputPdf: string, path where the PDF will be saved

Behavior:

• Each image becomes one page in the PDF
• Page size matches the image dimensions
• Supports PNG and JPG images

Returns: The output PDF file path

Example Usage

` import PDF from "starlight-pdf";

func main() { let images = await PDF.pdfToImages( "document.pdf", "output/images" );

sldeploy "PDF converted to images successfully";

await PDF.imagesToPdf( images, "output/new-document.pdf" );

sldeploy "Images converted back to PDF"; }

main(); `

Notes

• This module uses high-resolution rendering for clear images
• File paths can be relative or absolute
• Asynchronous functions must be used with await
• Suitable for automation, document processing, and preview systems

End of Documentation