Neptunian Parity Mnemonic

    react-native-biometric-login
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    react-native-biometric-login

    A React-Native module to enable biometric login and securely store a user's credentials using native apis. The user's credentials are encrypted and stored using Keychain on iOS and Encrypted Shared Preferences on Android.

    Installation

    npm install react-native-biometric-login --save
    
    cd ios && pod install && cd ..

    or

    yarn add react-native-biometric-login
    
    cd ios && pod install && cd ..

    Usage

    import {
      BiometricIsAvailable,
      BasicBiometricAuth,
      LoginBiometricAuth,
      SetUser,
      UpdateUser,
      GetUser,
      DeleteUser,
    } from 'react-native-biometric-login';
    
    // ...
    
    const result = await BiometricIsAvailable();

    API

    1. BiometricIsAvailable() - Checks if a biometric authentication method is available on the device. Returns: Promise that resolves with true or false

    2. BasicBiometricAuth(title: string, description: string) - Opens a basic biometric login prompt. Returns: Promise that resolves with true if success or rejects with message if fail.

    3. LoginBiometricAuth(title: string, description: string) - Opens a biometric login prompt that returns stored user credentials. Returns: Promise that resolves with object {success: true, username: "username", password: "password"} if success or rejects with message if fail.

    4. SetUser(username: string, password: string) - Save the user's credentials. Returns: Promise that resolves with object {success: true, message: response_text} if success or rejects with message if fail.

    5. UpdateUser(username: string, password: string) - Update the user's credentials. Returns: Promise that resolves with object {success: true, message: response_text} if success or rejects with message if fail.

    6. GetUser() - Gets the user's credentials. Returns: Promise that resolves with object {success: true, username: "username", password: "password"} if success or rejects with message if fail.

    7. DeleteUser() - Deletes the user's credentials. Returns: Promise that resolves with object {success: true, message: response_text} if success or rejects with message if fail.

    Contributing

    See the contributing guide to learn how to contribute to the repository and the development workflow.

    License

    MIT

    Install

    npm i react-native-biometric-login

    DownloadsWeekly Downloads

    7

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    120 kB

    Total Files

    41

    Last publish

    Collaborators

    • thang2162