capacitor-biometric-plugin
v3.0.0-beta1
Published
A capacitor plugin for using biometric features of android and iOS devices.
Readme
capacitor-biometric-plugin
A capacitor plugin for using biometric features of android and iOS devices. This is a capacitor 4 version of the plugin created by Ariel Henández Musa https://github.com/arielhernandezmusa/capacitor-biometric-auth.
Install
npm install capacitor-biometric-plugin
npx cap syncAPI
isAvailable()
isAvailable() => Promise<AvailableOptions>Returns: Promise<AvailableOptions>
verify(...)
verify(options: { reason: string; }) => Promise<VerifyOptions>| Param | Type |
| ------------- | -------------------------------- |
| options | { reason: string; } |
Returns: Promise<VerifyOptions>
Interfaces
AvailableOptions
| Prop | Type |
| ------------ | ----------------------------------------------- |
| has | boolean |
| status | ErrorCode |
| type | 'none' | 'touch' | 'face' |
ErrorCode
| Prop | Type |
| ----------------- | ------------------- |
| error | number |
| description | string |
VerifyOptions
| Prop | Type |
| -------------- | ----------------------------------------------- |
| verified | boolean |
| status | ErrorCode |