use-pdf-renderer/dist/index.d.ts

React hook for rendering PDF files as images

import "pdfjs-dist/build/pdf.worker.min";
export interface UsePdfRendererOptions {
    scale?: number;
    withCredentials?: boolean;
    quality?: number;
    imageType?: 'png' | 'jpeg';
}
export interface UsePdfRendererReturn {
    images: string[];
    loading: boolean;
    progress: number;
    error: Error | null;
    renderPdf: (pdfUrl: string) => Promise<void>;
    reset: () => void;
}
/**
 * React hook for rendering PDF files as images
 * @param options Configuration options for PDF rendering
 * @returns Object containing rendered images and control functions
 * @example
 * ```tsx
 * const { images, loading, renderPdf } = usePdfRenderer();
 * await renderPdf('https://example.com/document.pdf');
 * ```
 */
export declare const usePdfRenderer: (options?: UsePdfRendererOptions) => UsePdfRendererReturn;