@techstark/opencv-js 4.10.0-release.1 → 4.11.0-release.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -3
- package/dist/opencv.js +11 -12
- package/dist/opencv.js.patch +4 -4
- package/dist/src/types/opencv/Feature2D.d.ts +1 -1
- package/dist/src/types/opencv/ORB.d.ts +1 -1
- package/dist/src/types/opencv/RotatedRect.d.ts +7 -8
- package/dist/src/types/opencv/_hacks.d.ts +1 -1
- package/package.json +6 -6
- package/src/types/opencv/Feature2D.ts +1 -1
- package/src/types/opencv/ORB.ts +1 -1
- package/src/types/opencv/RotatedRect.ts +6 -7
- package/src/types/opencv/_hacks.ts +5 -5
package/README.md
CHANGED
|
@@ -1,14 +1,41 @@
|
|
|
1
1
|
# opencv-js
|
|
2
2
|
|
|
3
|
-
OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/4.
|
|
3
|
+
OpenCV JavaScript version (NPM package) for node.js or browser. Get started guide [OpenCV.js Tutorials](https://docs.opencv.org/4.11.0/#:~:text=OpenCV%2DPython%20Tutorials-,OpenCV.js%20Tutorials,-Tutorials%20for%20contrib).
|
|
4
4
|
|
|
5
|
-
The file `opencv.js` was downloaded from https://docs.opencv.org/4.
|
|
5
|
+
The file `opencv.js` was downloaded from https://docs.opencv.org/4.11.0/opencv.js
|
|
6
6
|
|
|
7
7
|
TypeScript is supported (thanks to `mirada`).
|
|
8
8
|
|
|
9
|
+
# Basic Usage
|
|
10
|
+
|
|
11
|
+
## >=4.11
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
import cvReadyPromise from "@techstark/opencv-js";
|
|
15
|
+
|
|
16
|
+
async function main() {
|
|
17
|
+
const cv = await cvReadyPromise;
|
|
18
|
+
console.log("OpenCV.js is ready!");
|
|
19
|
+
// You can now use OpenCV functions here
|
|
20
|
+
console.log(cv.getBuildInformation());
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## <=4.10
|
|
25
|
+
|
|
26
|
+
```js
|
|
27
|
+
import cv from "@techstark/opencv-js";
|
|
28
|
+
|
|
29
|
+
cv.onRuntimeInitialized = () => {
|
|
30
|
+
console.log("OpenCV.js is ready!");
|
|
31
|
+
// You can now use OpenCV functions here
|
|
32
|
+
console.log(cv.getBuildInformation());
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
9
36
|
# Code Examples
|
|
10
37
|
|
|
11
|
-
- See code examples (React, Angular) in [opencv-js-examples](https://github.com/TechStark/opencv-js-examples)
|
|
38
|
+
- See code examples (React, Angular, Node.js) in [opencv-js-examples](https://github.com/TechStark/opencv-js-examples)
|
|
12
39
|
|
|
13
40
|
# Live Demo
|
|
14
41
|
|