UNPKG

capacitor-biometric-authentication

Version:

Framework-agnostic biometric authentication library. Works with React, Vue, Angular, or vanilla JS. No providers required!

25 lines (24 loc) 1.54 kB
import type { BiometricAuthOptions, BiometricAuthResult, BiometricAuthConfiguration, BiometricAuthAdapter, BiometricAuthState, BiometryType, BiometricError } from './core/types'; declare const BiometricAuth: { configure: (config: Partial<BiometricAuthConfiguration>) => void; isAvailable: () => Promise<boolean>; getSupportedBiometrics: () => Promise<BiometryType[]>; authenticate: (options?: BiometricAuthOptions) => Promise<BiometricAuthResult>; deleteCredentials: () => Promise<void>; hasCredentials: () => Promise<boolean>; logout: () => void; getState: () => BiometricAuthState; isAuthenticated: () => boolean; subscribe: (callback: (state: BiometricAuthState) => void) => () => void; requireAuthentication: (callback: () => void | Promise<void>, options?: BiometricAuthOptions) => Promise<void>; withAuthentication: <T>(callback: () => T | Promise<T>, options?: BiometricAuthOptions) => Promise<T>; registerAdapter: (name: string, adapter: BiometricAuthAdapter) => void; }; export type { BiometricAuthOptions, BiometricAuthResult, BiometricAuthConfiguration, BiometricAuthAdapter, BiometricAuthState, BiometryType, BiometricError }; export { BiometricErrorCode } from './core/types'; export default BiometricAuth; export { BiometricAuth }; export { BiometricAuthCore } from './core/BiometricAuthCore'; export { PlatformDetector } from './core/platform-detector'; export { WebAdapter } from './adapters/WebAdapter'; export { CapacitorAdapter } from './adapters/CapacitorAdapter';