pdf-to-images-browser/build/index.d.ts

A lightweight, no-configuration PDF-to-image library for browsers

import { DocumentInitParameters } from 'pdfjs-dist/types/src/display/api';

/**
 * Configuration for batch processing of PDF pages
 */
interface BatchProcessingConfig {
    /**
     * Number of pages to process in each batch
     * @default 5
     */
    batchSize?: number;
    /**
     * Callback for progress updates
     */
    onProgress?: (progress: {
        completed: number;
        total: number;
        batch: (string | Blob | ArrayBuffer)[];
    }) => void;
    /**
     * Time in ms to wait between batches to prevent UI blocking
     * @default 100
     */
    batchDelay?: number;
}
/**
 * Configuration options for converting PDF to images.
 */
type PDFToImagesOptions = BatchProcessingConfig & {
    /**
     * Output image format - either PNG or JPEG
     * @default 'png'
     */
    format?: 'png' | 'jpg';
    /**
     * Scale factor for the output images. Default is 1.0
     * @default 1.0
     */
    scale?: number;
    /**
     * Which pages to convert. Can be 'all', 'first', 'last', a page number, array of numbers, or range
     * @example
     * // Convert all pages
     * pages: 'all'
     * // Convert only first page
     * pages: 'first'
     * // Convert only last page
     * pages: 'last'
     * // Convert specific page
     * pages: 2
     * // Convert multiple specific pages
     * pages: [1, 3, 5]
     * // Convert range of pages
     * pages: { start: 1, end: 5 }
     * @default 'all'
     */
    pages?: PDFPageSelection;
    /**
     * Desired output format of the converted images
     * @default 'base64'
     */
    output?: 'buffer' | 'base64' | 'blob' | 'dataurl';
    /** Additional PDF document parameters */
    docParams?: PDFDocumentParams;
};
/**
 * Result type for PDF to images conversion.
 * Returns an array where each element can be a string (base64/dataURL),
 * Blob, or ArrayBuffer depending on the output option.
 */
type PDFToImagesResult = (string | Blob | ArrayBuffer)[];
/** Parameters for configuring PDF document loading */
type PDFDocumentParams = Omit<DocumentInitParameters, 'data' | 'url'>;
/**
 * Specifies which pages to process from a PDF document.
 * Can be 'first', 'last', 'all', a specific page number,
 * an array of page numbers, or a range with start/end.
 */
type PDFPageSelection = {
    start?: number;
    end?: number;
} | 'first' | 'last' | 'all' | number | number[];
/**
 * Supported input types for PDF source documents.
 * Can be a string (base64/URL), URL object, ArrayBuffer, or File.
 */
type PDFSource = string | URL | ArrayBuffer | File;

/**
 * Converts a PDF document to an array of images with improved performance.
 * @param source - The PDF source to convert.
 * @param options - Optional configuration options for the conversion.
 * @returns A promise that resolves to an array of images.
 */
declare function pdfToImages(source: PDFSource, options?: PDFToImagesOptions): Promise<PDFToImagesResult>;

export { type BatchProcessingConfig, type PDFDocumentParams, type PDFPageSelection, type PDFSource, type PDFToImagesOptions, type PDFToImagesResult, pdfToImages as default };