feat!: deprecate defineUnPDFConfig for configureUnPDF

unjs · Nov 9, 2023 · 014a6ea · 014a6ea
1 parent 02afd71
commit 014a6ea
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -87,10 +87,11 @@ for (let i = 1; i <= doc.numPages; i++) {
 Generally speaking, you don't need to worry about the PDF.js build. `unpdf` ships with a serverless build of the latest PDF.js version. However, if you want to use the official PDF.js version or the legacy build, you can define a custom PDF.js module.
 
 ```ts
-// Before using any other methods, define the PDF.js module
-import { defineUnPDFConfig } from "unpdf";
+// Before using any other method, define the PDF.js module
+// if you need another PDF.js build
+import { configureUnPDF } from "unpdf";
 
-defineUnPDFConfig({
+configureUnPDF({
   // Use the official PDF.js build (make sure to install it first)
   pdfjs: () => import("pdfjs-dist"),
 });
@@ -118,12 +119,12 @@ interface UnPDFConfiguration {
 
 ## Methods
 
-### `defineUnPDFConfig`
+### `configureUnPDF`
 
 Define a custom PDF.js module, like the legacy build. Make sure to call this method before using any other methods.
 
 ```ts
-function defineUnPDFConfig(config: UnPDFConfiguration): Promise<void>;
+function configureUnPDF(config: UnPDFConfiguration): Promise<void>;
 ```
 
 ### `getResolvedPDFJS`
@@ -172,9 +173,9 @@ In order to use this method, you have to meet the following requirements:
 **Example**
 
 ```ts
-import { defineUnPDFConfig, renderPageAsImage } from "unpdf";
+import { configureUnPDF, renderPageAsImage } from "unpdf";
 
-defineUnPDFConfig({
+configureUnPDF({
   // Use the official PDF.js build
   pdfjs: () => import("pdfjs-dist"),
 });

diff --git a/src/config.ts b/src/config.ts
@@ -1,7 +1,7 @@
 import { resolvePDFJSImports } from "./utils";
 import type { UnPDFConfiguration } from "./types";
 
-export async function defineUnPDFConfig(options: UnPDFConfiguration) {
+export async function configureUnPDF(options: UnPDFConfiguration) {
   const { pdfjs } = { ...options };
 
   if (pdfjs) {

diff --git a/src/index.ts b/src/index.ts
@@ -5,14 +5,19 @@ import {
   renderPageAsImage as _renderPageAsImage,
 } from "./image";
 import { resolvePDFJSImports } from "./utils";
+import { configureUnPDF } from "./config";
 
-export { defineUnPDFConfig } from "./config";
 export {
   getDocumentProxy,
   getResolvedPDFJS,
   resolvePDFJSImports,
 } from "./utils";
 
+export { configureUnPDF } from "./config";
+/** @deprecated Use `configureUnPDF` instead */
+const defineUnPDFConfig = configureUnPDF;
+export { defineUnPDFConfig };
+
 export const getMeta: typeof _getMeta = async (...args) => {
   await resolvePDFJSImports();
   return await _getMeta(...args);