@dft/onyx-typedefs
v1.0.1
Published
Typescript typedefs for ONYX
Downloads
16
Readme
@dft/onyx-typdefs
Typescript typedefs for ONYX
Install
npm install @dft/onyx-typedefsAPI
exec(...)
exec(options: IOnyxConfiguration) => any| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| options | IOnyxConfiguration |
Returns: any
Interfaces
IOnyxConfiguration
| Prop | Type |
| ------------------------------------ | ------------------------------------------------------------------------- |
| action | OnyxPluginAction |
| onyxLicense | string |
| returnRawImage | boolean |
| returnProcessedImage | boolean |
| returnEnhancedImage | boolean |
| returnBlackWhiteProcessedImage | boolean |
| returnFingerprintTemplate | boolean |
| returnWSQ | boolean |
| shouldConvertToISOTemplate | boolean |
| computeNfiqMetrics | boolean |
| wholeFingerCrop | boolean |
| useManualCapture | boolean |
| useOnyxLive | boolean |
| useFlash | boolean |
| showLoadingSpinner | boolean |
| reticleOrientation | OnyxReticleOrientation |
| reticleAngle | number |
| reticleScale | number |
| backgroundColorHexString | string |
| showBackButton | boolean |
| showManualCaptureText | boolean |
| manualCaptureText | string |
| backButtonText | string |
| cropFactor | number |
| cropSize | IOnyxCropSize |
| probe | string |
| reference | string |
| pyramidScales | {} |
IOnyxCropSize
| Prop | Type |
| ------------ | ------------------- |
| width | number |
| height | number |
IOnyxPluginResult
| Prop | Type |
| ----------------- | -------------------- |
| action | string |
| onyxResults | {} |
| isVerified | boolean |
| matchScore | number |
IOnyxResult
| Prop | Type |
| ------------------------------------------- | ------------------------------------------------------------------- |
| rawFingerprintDataUri | string |
| processedFingerprintDataUri | string |
| enhancedFingerprintDataUri | string |
| blackWhiteProcessedFingerprintDataUri | string |
| base64EncodedFingerprintTemplate | string |
| base64EncodedWsqBytes | string |
| base64EncodedGrayRawWsqBytes | string |
| captureMetrics | IOnyxCaptureMetrics |
IOnyxCaptureMetrics
| Prop | Type |
| ------------------------ | ------------------------------------------------------------- |
| nfiqMetrics | IOnyxNfiqMetrics |
| livenessConfidence | number |
| focusQuality | number |
IOnyxNfiqMetrics
| Prop | Type |
| --------------- | ------------------- |
| nfiqScore | number |
| mlpScore | number |
Enums
OnyxPluginAction
| Members | Value |
| ------------- | ---------------------- |
| CAPTURE | capture |
| MATCH | match |
OnyxReticleOrientation
| Members | Value |
| -------------------- | ----------------------------- |
| LEFT | LEFT |
| RIGHT | RIGHT |
| THUMB_PORTRAIT | THUMB_PORTRAIT |
