@regulaforensics/document-reader-webclient 6.9.4 → 6.9.5
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 +5 -4
- package/dist/main/index.cjs +1 -1
- package/dist/module/index.js +1 -1
- package/lib/index.d.ts +63 -71
- package/package.json +8 -13
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Documents recognition as easy as reading two bytes.
|
|
|
10
10
|
|
|
11
11
|
If you have any problems with or questions about this client, please contact us
|
|
12
12
|
through a [GitHub issue](https://github.com/regulaforensics/DocumentReader-api-js-client/issues).
|
|
13
|
-
You are invited to contribute new features, fixes, or updates, large or small.
|
|
13
|
+
You are invited to contribute new features, fixes, or updates, large or small.
|
|
14
14
|
We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
|
15
15
|
See [dev guide](https://github.com/regulaforensics/DocumentReader-web-js-client/blob/master/dev.md)
|
|
16
16
|
|
|
@@ -19,7 +19,7 @@ See [dev guide](https://github.com/regulaforensics/DocumentReader-web-js-client/
|
|
|
19
19
|
```
|
|
20
20
|
npm install @regulaforensics/document-reader-webclient
|
|
21
21
|
```
|
|
22
|
-
## Example
|
|
22
|
+
## Basic Example
|
|
23
23
|
|
|
24
24
|
Performing request:
|
|
25
25
|
```js
|
|
@@ -38,17 +38,18 @@ Parsing results:
|
|
|
38
38
|
const docNumber = result.text?.getField(DOCUMENT_NUMBER);
|
|
39
39
|
const fullName = result.text?.getField(SURNAME_AND_GIVEN_NAMES);
|
|
40
40
|
const dateOfBirth = result.text?.getField(DATE_OF_BIRTH);
|
|
41
|
-
|
|
41
|
+
|
|
42
42
|
// graphics fields
|
|
43
43
|
const portraitAsBase64 = result.images?.getField(PORTRAIT);
|
|
44
44
|
const signatureAsBase64 = result.images?.getField(SIGNATURE);
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
+
|
|
47
48
|
## Compatibility
|
|
48
49
|
|
|
49
50
|
Language level
|
|
50
51
|
* ES5 with some ES6 features [Promise] and whatwg **URL**. If your environment doesn't support ES6 required features, you can polyfill.
|
|
51
|
-
* nodejs
|
|
52
|
+
* nodejs 18+
|
|
52
53
|
|
|
53
54
|
Module system
|
|
54
55
|
* CommonJS
|