@tauri-apps/plugin-biometric

Enumerations

BiometryType

Source: undefined

Enumeration Members

FaceID

FaceID: 2;

Source: undefined

Iris

Iris: 3;

Source: undefined

None

None: 0;

Source: undefined

TouchID

TouchID: 1;

Source: undefined

Interfaces

AuthOptions

Source: undefined

Properties

Property	Type	Defined in
allowDeviceCredential?	boolean	Source: undefined
cancelTitle?	string	Source: undefined
confirmationRequired?	boolean	Source: undefined
fallbackTitle?	string	Source: undefined
maxAttemps?	number	Source: undefined
subtitle?	string	Source: undefined
title?	string	Source: undefined

---

Status

Source: undefined

Properties

Property	Type	Defined in
biometryType	BiometryType	Source: undefined
error?	string	Source: undefined
errorCode?	| "appCancel" | "authenticationFailed" | "invalidContext" | "notInteractive" | "passcodeNotSet" | "systemCancel" | "userCancel" | "userFallback" | "biometryLockout" | "biometryNotAvailable" | "biometryNotEnrolled"	Source: undefined
isAvailable	boolean	Source: undefined

Functions

authenticate()

function authenticate(reason, options?): Promise<void>;

Source: undefined

Prompts the user for authentication using the system interface (touchID, faceID or Android Iris). Rejects if the authentication fails.

import { authenticate } from "@tauri-apps/plugin-biometric";
await authenticate('Open your wallet');

Parameters

Parameter	Type	Description
reason	string	-
options?	AuthOptions	-

Returns

Promise<void>

---

checkStatus()

function checkStatus(): Promise<Status>;

Source: undefined

Checks if the biometric authentication is available.

Returns

Promise<Status>

a promise resolving to an object containing all the information about the status of the biometry.