# @kode-frontend/react-native-biometry-tools

> Tools and helpers for biometry

Latest version **2.0.12** (published 2026-08-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kode-frontend/react-native-biometry-tools
pnpm add @kode-frontend/react-native-biometry-tools
yarn add @kode-frontend/react-native-biometry-tools
bun add @kode-frontend/react-native-biometry-tools
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.0.12 |
| Published | 2026-08-20 |
| First published | 2021-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 134 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | frontend-team@kode.ru |
| Maintainers | kode-frontend |
| Keywords | react-native, ios, android |

## Links

- npm: https://www.npmjs.com/package/@kode-frontend/react-native-biometry-tools
- Repository: https://github.com/appKODE/react-native-biometry-tools
- Homepage: https://github.com/appKODE/react-native-biometry-tools#readme
- Issues: https://github.com/appKODE/react-native-biometry-tools/issues
- npm.io page: https://npm.io/package/@kode-frontend/react-native-biometry-tools

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.12 (latest) — 2026-08-20
- 0.1.10 (undefined) — 2021-12-11
- 2.0.11 — 2026-08-18
- 2.0.9 — 2026-08-17
- 0.2.6 — 2025-05-06
- 0.2.5 — 2025-05-06
- 0.2.4 — 2025-05-05
- 0.2.3 — 2025-05-04
- 0.1.15 — 2022-12-01
- 0.1.14 — 2021-12-11
- 0.1.13 — 2021-12-11
- 0.1.11 — 2021-12-11

## README

# react-native-biometry-tools

A lightweight library for determining the supported type of biometrics.

## 📋 Requirements

| Requirement           | Version  |
| --------------------- | -------- |
| React Native          | ≥ 0.75   |
| react-native-nitro-modules | ≥ 0.35 |
| iOS                   | ≥ 15.1   |
| Android minSdkVersion | ≥ 24     |

> **Note:** This library uses [Nitro Modules](https://nitro.margelo.com/).

## 📥 Installation

```sh
yarn add @kode-frontend/react-native-biometry-tools react-native-nitro-modules
```

### iOS

```sh
cd example/ios && pod install
```

## 🎮 Usage

```js
import BiometryTools, { BiometryType, isAuthenticationCanceledError } from '@kode-frontend/react-native-biometry-tools';

export default function App() {

  React.useEffect(() => {
    // Async: check if biometry is available and enrolled
    BiometryTools
      .isSensorAvailable()
      .then((biometryType) => {
          // sensor available
          // biometryType - supported biometry
      })
      .catch((e) => {
        // sensor not available
        // biometry not supported or not enrolled
        console.log(e.message)
        console.log(e.code)
      })

    // Async: get supported biometry type even if not enrolled
    BiometryTools
      .getSupportedBiometryType()
      .then((biometryType) => {
          // even if biometry not enrolled
          // biometryType - supported biometry, if biometry not supported then return null
      })

    // Sync: instantly check if biometry is available and enrolled
    const biometryType = BiometryTools.isSensorAvailableSync();
    if (biometryType) {
      console.log('Available biometry:', biometryType);
    }

    // Sync: instantly get supported biometry type even if not enrolled
    const supportedType = BiometryTools.getSupportedBiometryTypeSync();
    console.log('Supported biometry:', supportedType); // null if not supported
  }, []);

  return (
    <Button
        title="Prompt authentication"
        onPress={() => {
          BiometryTools.authenticate('Title', { 
            subtitle: 'subtitle',
            description: 'description', 
            withDeviceCredentials: true, 
            cancelText: 'Cancel' 
          })
            .then((result) => {
              console.log('Prompt result:', result);
            })
            .catch((e) => {
              if (isAuthenticationCanceledError(e)) {
                return console.log('Cancelled by user')
              }
              console.log('Prompt error:', e.message);
            });
        }}
      />
  );
}
```

## 📦 Available methods

| Method                                                    | Returns                   | Description                                                                                              |
| --------------------------------------------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------- |
| `isSensorAvailable()`                                     | `Promise<BiometryType>`   | Returns supported biometry type if biometry is available **and enrolled**, otherwise throws `BiometryError` |
| `isSensorAvailableSync()`                                 | `BiometryType \| null`    | **Synchronous** version of `isSensorAvailable`. Returns `null` instead of throwing                      |
| `getSupportedBiometryType()`                              | `Promise<BiometryType \| null>` | Returns supported biometry type if hardware is present, `null` otherwise. Does not require enrollment  |
| `getSupportedBiometryTypeSync()`                          | `BiometryType \| null`    | **Synchronous** version of `getSupportedBiometryType`                                                    |
| `authenticate(title: string, options: AuthenticateOptions)` | `Promise<AuthenticationResult>` | Shows the biometry prompt and resolves with the authentication result                              |

### Sync methods

`isSensorAvailableSync()` and `getSupportedBiometryTypeSync()` execute on the JS thread without bridging overhead. Use them when you need the biometry status immediately on render — for example, to conditionally show a biometry button before any async operation completes.

```ts
// Render a biometry icon without waiting for a promise
const biometryType = BiometryTools.getSupportedBiometryTypeSync();
```

## Types

```ts

enum BiometryType {
  // ios only
  FACE_ID = 'Face ID',
  TOUCH_ID = 'Touch ID',
  // android only
  FINGERPRINT = 'Fingerprint',
  FACE = 'Face',
  IRIS = 'Iris'
}


enum BiometryErrorCode {
  // common  
  NOT_SUPPORTED = 'BiometryScannerNotSupported',
  NOT_ENROLLED = 'BiometryScannerNotEnrolled',
  // ios only
  NOT_AVAILABLE = 'BiometryScannerNotAvailable',
  PASSCODE_NOT_SET = 'PasscodeNotSet',
  DEVICE_LOCKED_PERMANENT = 'DeviceLockedPermanent'

  // authentication
  AUTHENTICATION_CANCELED = 'AuthenticationCanceledByUser',
}

type AuthenticateOptions = {
  withDeviceCredentials?: boolean,
  /**
   * Cancel button text. Android only
   */
  cancelText?: string,
  /**
   * Subtitle for prompt. Android only
   */
  subtitle?: string,
  /**
   * Description for prompt. Android only
   */
  description?: string,
}

```

## Builds

`release` - create release tag and increase version

---
_Source: https://npm.io/package/@kode-frontend/react-native-biometry-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
