1.1.0

方法與屬性

最後更新


本頁列出 pdf2image 實例的公開方法與屬性,以及各自的 resolve/reject 值。

一覽


成員簽章resolvereject
convertconvert(): Promise<string[]>Data URL 陣列(與 images 為同一個陣列)字串或 Error,見 轉換流程
downloaddownload(): Promise<void>undefined(下載已觸發,或 file 為空而略過)convert() 的 reject 值,或 JSZip 失敗時的 []
imagesget images(): string[]——

convert()


併發渲染所有頁面並回傳 Data URL 陣列,期間顯示進度遮罩。每個實例只能成功呼叫一次,因為 file 會在第一次轉換時被轉移。細節見 轉換流程。

download()


把結果打包成 {filename}.zip 並觸發瀏覽器下載;尚未轉換時會先呼叫 convert()。細節見 ZIP 下載。

images


唯讀 getter,回傳內部結果陣列本身(不是複本)。轉換前為空陣列;convert() resolve 的陣列與它是同一個參考,修改其中一個會反映到另一個,也會影響之後 download() 打包的內容。
  1. <script>
  2. addEventListener("load", async () => {
  3. const buffer = await (await fetch("/assets/sample.pdf")).arrayBuffer();
  4. const converter = new pdf2image({ file: buffer, type: "png", scale: 0.5 });
  5. console.log("before:", converter.images.length);
  6. const result = await converter.convert();
  7. console.log("after:", converter.images.length, "same array:", result === converter.images);
  8. result.pop();
  9. console.log("after pop:", converter.images.length);
  10. });
  11. </script>
即時預覽 · @pardnchiu/pdf2image@1.1.2

未公開的成員


#filename、#file、#type、#scale、#result、#formatDate() 是 ES 私有欄位,外部無法存取。進度遮罩類別 pdf2imageLoading 只在模組內使用,不掛到 window。

相關頁面


EN