react-native-biometry/lib/typescript/biometry.d.ts

React native biometry

export type BiometryPromptOptions = {
    title?: string;
    subtitle?: string;
    description?: string;
    cancelText?: string;
};
export type BiometryAuthenticationOptions = {
    encryptedData?: string;
    prompt?: BiometryPromptOptions;
    securityKeyName?: string;
};
export type BiometryAvailabilityResult = {
    available: boolean;
    biometryType?: string;
    error?: string;
};
export type LocalAuthenticationResult = {
    success: true;
    data: string;
} | {
    success: false;
    data: null;
    error: string;
    warning?: string;
};
export type EncryptDataParams = {
    input: string;
    securityKeyName?: string;
};
export type EncryptDataResult = {
    data: string | null;
    success: boolean;
};
export declare enum SecurityLevel {
    NONE = 0,
    SECRET = 1,
    BIOMETRIC = 2
}
/** @public */
export declare class Biometry {
    static isAvailable(): Promise<BiometryAvailabilityResult>;
    static isEnrolled(): Promise<boolean>;
    static getEnrolledLevel(): Promise<SecurityLevel>;
    static encryptData(params: EncryptDataParams): Promise<EncryptDataResult>;
    static authenticate(options?: BiometryAuthenticationOptions): Promise<LocalAuthenticationResult>;
    static cancel(): Promise<void>;
}