# capacitor-plugin-biometric
biometric login with FaceId, Fingerprint and Iris. Depending to the device biometrics options.
## Install
```bash
npm install capacitor-plugin-biometric
npx cap sync
```
## API
* [`saveUser(...)`](#saveuser)
* [`getUser()`](#getuser)
* [`has(...)`](#has)
* [`isAvailable()`](#isavailable)
* [`verify(...)`](#verify)
* [`save(...)`](#save)
* [`saveDataUser(...)`](#savedatauser)
* [`getDataUser()`](#getdatauser)
* [`cleanAll(...)`](#cleanall)
### saveUser(...)
```typescript
saveUser(options: { "name": string; }) => Promise<{ value: string; }>
```
| Param | Type |
| ------------- | ------------------------------ |
| **`options`** | { name: string; } |
**Returns:** Promise<{ value: string; }>
--------------------
### getUser()
```typescript
getUser() => Promise<{ value: string; }>
```
**Returns:** Promise<{ value: string; }>
--------------------
### has(...)
```typescript
has(options: { value: string; }) => Promise<{ value: string; }>
```
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { value: string; } |
**Returns:** Promise<{ value: string; }>
--------------------
### isAvailable()
```typescript
isAvailable() => Promise<{ value: string; }>
```
**Returns:** Promise<{ value: string; }>
--------------------
### verify(...)
```typescript
verify(options: { "key": string; "message": string; }) => Promise<{ value: string; }>
```
| Param | Type |
| ------------- | ---------------------------------------------- |
| **`options`** | { key: string; message: string; } |
**Returns:** Promise<{ value: string; }>
--------------------
### save(...)
```typescript
save(options: { "key": string; "password": string; "userAuthenticationRequired": string; }) => Promise<{ value: string; }>
```
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------- |
| **`options`** | { key: string; password: string; userAuthenticationRequired: string; } |
**Returns:** Promise<{ value: string; }>
--------------------
### saveDataUser(...)
```typescript
saveDataUser(options: { value: string; }) => Promise<{ value: string; }>
```
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { value: string; } |
**Returns:** Promise<{ value: string; }>
--------------------
### getDataUser()
```typescript
getDataUser() => Promise<{ value: string; }>
```
**Returns:** Promise<{ value: string; }>
--------------------
### cleanAll(...)
```typescript
cleanAll(options: { "source": string; }) => Promise<{ value: string; }>
```
| Param | Type |
| ------------- | -------------------------------- |
| **`options`** | { source: string; } |
**Returns:** Promise<{ value: string; }>
--------------------
# capacitorBiometria