From 8a0ec08de1fb7fa12b1f5c3846c2157eba158cc9 Mon Sep 17 00:00:00 2001 From: ColonelParrot <65585002+ColonelParrot@users.noreply.github.com> Date: Wed, 10 May 2023 15:53:00 -0400 Subject: [PATCH] Update extractPaper documentation --- src/jscanify-node.js | 2 +- src/jscanify.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/jscanify-node.js b/src/jscanify-node.js index f8bf050..30ae041 100644 --- a/src/jscanify-node.js +++ b/src/jscanify-node.js @@ -140,8 +140,8 @@ class jscanify { * @param {*} image image to process * @param {*} resultWidth desired result paper width * @param {*} resultHeight desired result paper height - * @param {*} onComplete callback with `HTMLCanvasElement` passed - the unwarped paper * @param {*} cornerPoints optional custom corner points, in case automatic corner points are incorrect + * @returns `HTMLCanvasElement` containing undistorted image */ extractPaper(image, resultWidth, resultHeight, cornerPoints) { const canvas = createCanvas(); diff --git a/src/jscanify.js b/src/jscanify.js index 463369e..2dfd14e 100644 --- a/src/jscanify.js +++ b/src/jscanify.js @@ -131,8 +131,8 @@ * @param {*} image image to process * @param {*} resultWidth desired result paper width * @param {*} resultHeight desired result paper height - * @param {*} onComplete callback with `HTMLCanvasElement` passed - the unwarped paper * @param {*} cornerPoints optional custom corner points, in case automatic corner points are incorrect + * @returns `HTMLCanvasElement` containing undistorted image */ extractPaper(image, resultWidth, resultHeight, cornerPoints) { const canvas = document.createElement("canvas");