svelte-pdf-simple/types.d.ts

Svelte component for displaying PDF files easily

import type { TextContent, PDFDocumentProxy, DocumentInitParameters, TypedArray, PDFPageProxy } from "pdfjs-dist/types/src/display/api";
export { PDFDocumentProxy, PDFPageProxy, TextContent, TypedArray };
export declare type AdditionalParameters = Omit<DocumentInitParameters, "url" | "data" | "password" | "httpHeaders">;
export declare type Degrees = -360 | -270 | -180 | -90 | 0 | 90 | 180 | 270 | 360;
export declare type PdfPageContent = {
    annotations?: Record<string, unknown>[];
    textContent?: TextContent;
    pageRotation?: Degrees;
    pageNumber: number;
};
export declare type PdfLoadSuccess = {
    totalPages: number;
} & PdfPageContent;
export declare type PdfLoadFailure = PdfException;
export declare type PdfException = {
    name: PdfExceptionName;
    message?: string;
};
export declare enum PdfExceptionName {
    UnknownErrorException = "UnknownErrorException",
    InvalidPDFException = "InvalidPDFException",
    MissingPDFException = "MissingPDFException",
    UnexpectedResponseException = "UnexpectedResponseException",
    FormatError = "FormatError",
    AbortException = "AbortException",
    PasswordRequiredException = "PasswordRequired",
    IncorrectPasswordException = "IncorrectPassword"
}
export declare type Properties = {
    /**
     * - Url pointing to a pdf.
     */
    url?: string | URL;
    /**
     * - Local path pointing to a pdf.
     */
    path?: string;
    /**
     * - Raw pdf data
     */
    data?: string | number[] | TypedArray;
    /**
     * - Used if you are sourcing pdf from a Url
     * and need authentication or any custom headers to pass
     */
    httpHeaders?: Record<string, string>;
    /**
     * - If the pdf is protected by password, this value will be used to open it
     */
    password?: string;
    /**
     * - On which page to open the pdf upon first load
     * Default: 1
     */
    page?: number;
    /**
     * - How scaled up or down to be the pdf.
     * Default: 1
     */
    scale?: number;
    /**
     * - Rotation of the pdf
     * Default: 0
     */
    rotation?: Degrees;
    /**
     * - Offset on the x axis
     * Default: 0
     */
    offsetX?: number;
    /**
     * - Offset on the y axis
     * Default: 0
     */
    offsetY?: number;
    /**
     * - Whether or not to load Annotations
     * Default: false
     */
    withAnnotations?: boolean;
    /**
     * - Whether or not to load TextContent
     * Default: false
     */
    withTextContent?: boolean;
    /**
     * - Additional parameters exposed by 'pdfjs'
     */
    additionalParams?: AdditionalParameters;
};