Skip to content

Commit 57d92e7

Browse files
hieuvpphillbaker
authored andcommitted
docs(README): add biometry type
1 parent e35cb3a commit 57d92e7

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,12 +222,15 @@ export default FingerprintPopup;
222222
### `isSensorAvailable()`: (Android, iOS)
223223
Checks if Fingerprint Scanner is able to be used by now.
224224

225-
- Returns a `Promise`
225+
- Returns a `Promise<string>`
226+
- `biometryType: String` - The type of biometric authentication supported by the device.
227+
- `error: FingerprintScannerError { name, message }` - The reason of failure.
226228

227229
```javascript
228230
componentDidMount() {
229231
FingerprintScanner
230232
.isSensorAvailable()
233+
.then(biometryType => this.setState({ biometryType }))
231234
.catch(error => this.setState({ errorMessage: error.message }));
232235
}
233236
```
@@ -286,6 +289,14 @@ componentWillUnmount() {
286289
}
287290
```
288291

292+
### `Types of Biometrics`
293+
294+
| Value | OS |
295+
|---|---|
296+
| Touch ID | iOS |
297+
| Face ID | iOS |
298+
| Fingerprint | Android |
299+
289300
### `Errors`
290301

291302
| Name | Message |

0 commit comments

Comments
 (0)