@livelybone/easy-pdf/index.d.ts

An easy-to-use PDF rendering library in browser, can be used as a solution to customize the display of PDF in App. Based on mozilla/pdf.js, the js/css is loaded via CDN asynchronously. 一个简便易用的，原生使用方式的（适用于各大框架）网页端 PDF 渲染插件，也可作为小程序/App webview 中自定义展示 pdf 的解

interface PdfResources {
  /** Default: 'https://cdn.jsdelivr.net/npm/pdfjs-dist@2.2.228/web/pdf_viewer.css' */
  pdfViewerCssUrl?: string
  /** Default: 'https://cdn.jsdelivr.net/npm/pdfjs-dist@2.2.228/build/pdf.min.js' */
  pdfJsUrl?: string
  /** Default: 'https://cdn.jsdelivr.net/npm/pdfjs-dist@2.2.228/web/pdf_viewer.js' */
  pdfViewerJsUrl?: string
}

declare function loadPdfResources(resources?: PdfResources): Promise<any>

interface ReadPdfOptions extends PdfResources {
  cMapPacked: boolean
  /** Default: 'https://cdn.jsdelivr.net/npm/pdfjs-dist@2.2.228/cmaps/' */
  cMapUrl: string
  disableAutoFetch: boolean
  disableCreateObjectURL: boolean
  disableFontFace: boolean
  disableRange: boolean
  disableStream: boolean
  docBaseUrl: string
  isEvalSupported: string
  maxImageSize: number
  pdfBug: boolean
  verbosity: number
}

interface RenderPdfOptions {
  container: HTMLElement
  viewer?: HTMLElement
  readPdfOptions?: ReadPdfOptions
}

declare function readPdf(
  url: string,
  options?: Pick<
    ReadPdfOptions,
    Exclude<keyof ReadPdfOptions, 'pdfViewerCssUrl' | 'pdfViewerJsUrl'>
  >,
): Promise<any>

declare function renderPdf(
  url: string,
  options: RenderPdfOptions,
): Promise<{
  pdfViewer: any
  pdf: any
  pdfjsLib: any
  pdfjsViewer: any
}>

/**
 * @param pdf         The result of readPdf
 * @param pageIndex
 * @param options
 * */
declare function renderPdfPage(
  pdf: any,
  pageIndex: number,
  options: Pick<RenderPdfOptions, 'container'> & {
    loadPdfViewOptions?: Pick<
      ReadPdfOptions,
      'pdfViewerCssUrl' | 'pdfViewerJsUrl'
    >
  },
): Promise<{
  pdfViewer: any
  pdfPage: any
  pdfjsLib: any
  pdfjsViewer: any
}>

export {
  PdfResources,
  ReadPdfOptions,
  RenderPdfOptions,
  loadPdfResources,
  readPdf,
  renderPdf,
  renderPdfPage,
}