docs(keychain-touch-id): update docs description for verify method (#3726)

* chore: fixing typescript return types

* refactor(keychain-touch-id): more specific return types

* docs(keychain-touch-id): correct verify func desc
This commit is contained in:
John Borges 2021-09-03 08:29:57 -04:00 committed by GitHub
parent 54c197a5a6
commit 7886014423
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -57,7 +57,7 @@ export class KeychainTouchId extends IonicNativePlugin {
/**
* Opens the fingerprint dialog, for the given key, showing an additional message. Promise will resolve
* with the password stored in keychain or will resolve an error code, where -1 indicated not available.
* with the password stored in keychain or will reject with an error code, where "-1" indicated not available.
* @param key {string} the key you want to retrieve from keychain
* @param message {string} a message to the user
* @return {Promise<string>} Returns a promise that resolves when the key value is successfully retrieved or an error