Update API doc for cropImage function 💞

willnguyen1312 · Nov 14, 2023 · b168a81 · b168a81
1 parent 33c2fbd
commit b168a81
Showing 1 changed file with 4 additions and 7 deletions.
diff --git a/packages/docs/src/api/cropImage.md b/packages/docs/src/api/cropImage.md
@@ -9,12 +9,7 @@ Crop the current image based on the zoom level
 ### Basic Usage
 
 ```ts
-const croppedImage = cropImage({
-  currentZoom: number
-  image: HTMLImageElement
-  positionX: number
-  positionY: number
-})
+const croppedImage = await cropImage(arg: CropImageArg)
 ```
 
 ### Type Declaration
@@ -29,7 +24,9 @@ type CropImageArg = {
   positionY: number
   // Current zoom level from createZoomImageWheel
   currentZoom: number
+  // Current rotation from createZoomImageWheel - default 0
+  rotation?: number
 }
 
-function cropImage = (arg: CropImageArg) => string
+async function cropImage = (arg: CropImageArg) => string
 ```