unpdf 0.7.1 → 0.8.0

package/README.md

@@ -14,6 +14,11 @@ This library is also intended as a modern alternative to the unmaintained but st
 - 🧱 Opt-in to legacy PDF.js build
 - 💨 Zero dependencies
 
+## PDF.js Compatibility
+
+> [!NOTE]
+> This package is currently using PDF.js v4.0.189.
+
 ## Installation
 
 Run the following command to add `unpdf` to your project.
@@ -194,31 +199,22 @@ declare function renderPageAsImage(
   data: BinaryData | PDFDocumentProxy,
   pageNumber: number,
   options?: {
-    canvas?: () => Promise<typeof "canvas">;
+    canvas?: () => Promise<typeof import("canvas")>;
     /** @default 1 */
-    scale?: number
+    scale?: number;
     width?: number;
     height?: number;
   },
 ): Promise<ArrayBuffer>;
 ```
 
-### `extractImages`
-
-```ts
-function extractImages(
-  data: BinaryData | PDFDocumentProxy,
-  pageNumber: number,
-): Promise<Uint8ClampedArray[]>;
-```
-
 ## FAQ
 
-### Why Is `canvas` A Peer Dependency?
+### Why Is `canvas` An Optional Dependency?
 
 The official PDF.js library depends on the `canvas` module for Node.js environments, which [doesn't work inside worker threads](https://github.com/Automattic/node-canvas/issues/1394). That's why `unpdf` ships with a serverless build of PDF.js that mocks the `canvas` module.
 
-However, to render PDF pages as images, you need to install the `canvas` module in Node.js environments. That's why `canvas` is a peer dependency.
+However, to render PDF pages as images in Node.js environments, you need to install the `canvas` module. That's why it is a peer dependency.
 
 ## License