bry-biometric-collector 2.2.22 → 2.2.24

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 CHANGED
@@ -567,7 +567,7 @@ The web component listens to and emits a few events. The events emitted are:
567
567
 
568
568
  - **document-scrapped**: When the user scraps their document photo (by clicking capture again after having saved their picture) this event gets emitted without any data.
569
569
 
570
- - **export-document**: When the user saves their document photo (by clicking finish), an event of this kind is emitted with their picture like so:
570
+ - **export-document**: When the user saves their document photo (by clicking finish), an event of this kind is fired with their picture like so:
571
571
 
572
572
  ```ts
573
573
  {detail: {bodyPart: 'DOCUMENT', data: string, justification: string}}
@@ -581,6 +581,12 @@ And the events the webcomponent listens to are:
581
581
  dispatchEvent(new CustomEvent('change-tabs', { detail: 'Face' }));
582
582
  ```
583
583
 
584
+ - **extension-error**: When extension errors are caught, this event is fired . The data is exported like so:
585
+
586
+ ```ts
587
+ {detail :{code: number, description: string, key: string }};
588
+ ```
589
+
584
590
  ## **Slots**
585
591
 
586
592
  Due to the computational power required to find finger matches in the browser, the main thread gets stuck when a finger is scanned. To circumvent this, the web-component uses a gif with a delay to show the gif before computation begins. As a way for the user to not lose the ability to customize the loading gif, we implemented a slot. This way, the loading gif and its accompanying text can be completely overhauled. To override the loading gif, the passed-in element's `slot` property must be set to `validating-fingerprint-gif`. Below we provide an example of how to do that.