@opencvjs/web 4.10.0-release.2 → 4.10.0-release.4

package/README.md

@@ -10,49 +10,24 @@ npm install @opencvjs/web
 
 ## Usage
 
-`@opencvjs/web` exports a `load` function that returns a Promise that resolves to the OpenCV.js API.
+`@opencvjs/web` exports a `loadOpenCV` function that returns a Promise that resolves to the OpenCV.js API.
 
 ```ts
-import { load } from "@opencvjs/web";
+import { loadOpenCV } from "@opencvjs/web";
 
-async function main() {
-  // Wait for the OpenCV.js library to load
-  const cv = await load();
-
-  const imgSrc = document.getElementById("img_src");
-  const imgDst = document.getElementById("img_dst");
-
-  // Wait for the image to load
-  await imgSrc.decode();
-
-  // Read the image
-  let src = cv.imread(imgSrc);
-
-  // Convert the image to grayscale
-  let dst = new cv.Mat();
-  cv.cvtColor(src, dst, cv.COLOR_RGBA2GRAY, 0);
-
-  // Show the grayscale image
-  cv.imshow(imgDst, dst);
-
-  // Release the memory
-  src.delete();
-  dst.delete();
-}
-
-main();
+const cv = await loadOpenCV();
+const mat = new cv.Mat();
 ```
 
 ## TypeScript
 
-`@opencvjs/web` exports a type definition for the OpenCV.js API.
+`@opencvjs/web` exports a type `OpenCV` for the OpenCV.js API.
 
 ```ts
-import type { OpenCV } from "@opencvjs/web";
-import { load } from "@opencvjs/web";
+import { loadOpenCV, type OpenCV } from "@opencvjs/web";
 
-const cv = await load();
-const src: OpenCV.Mat = cv.imread(imgSrc);
+const cv: typeof OpenCV = await loadOpenCV();
+const mat: OpenCV.Mat = new cv.Mat();
 ```
 
 ## Example

package/lib/index.d.ts

@@ -4,7 +4,7 @@ import type { OpenCV } from "@opencvjs/types";
  * Compile the WASM library and return a promise that resolves to the
  * OpenCV.js library.
  */
-declare function load(): Promise<typeof OpenCV>;
+declare function loadOpenCV(): Promise<typeof OpenCV>;
 
 export type { OpenCV };
-export { load };
+export { loadOpenCV };

package/lib/index.js

@@ -2,7 +2,7 @@ import cv from "./opencv_js.js";
 
 let promise;
 
-export function load() {
+export function loadOpenCV() {
   if (!promise) {
     promise = cv();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencvjs/web",
-  "version": "4.10.0-release.2",
+  "version": "4.10.0-release.4",
   "author": "ocavue <ocavue@gmail.com>",
   "repository": "https://github.com/ocavue/opencvjs",
   "type": "module",
@@ -11,7 +11,7 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@opencvjs/types": "4.10.0-release.2"
+    "@opencvjs/types": "4.10.0-release.3"
   },
   "license": "Apache-2.0",
   "publishConfig": {