feat(plugin): return available type instead of boolean (#10)

* returning type instead of boolean * update readme * comment * double quotes
danielsogl · Nov 14, 2019 · c611f57 · c611f57
1 parent ed23017
commit c611f57
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ FaceId.isAvailable().then(checkResult => {
 
 ## API
 
-| Method                            | Default                                             | Type                          | Description                                |
-| --------------------------------- | --------------------------------------------------- | ----------------------------- | ------------------------------------------ |
-| isAvailable()                     |                                                     | `Promise<{ value: boolean }>` | Checks if Face ID or Touch ID is available |
-| auth(options?: {reason?: string}) | options: {reason: "Access requires authentication"} | `Promise<void>`               | Displays the Face ID or Touch ID screen    |
+| Method                            | Default                                             | Type                         | Description                                                         |
+| --------------------------------- | --------------------------------------------------- | ---------------------------- | ------------------------------------------------------------------- |
+| isAvailable()                     |                                                     | `Promise<{ value: string }>` | Checks if Face ID or Touch ID is available, and returns type if so. |
+| auth(options?: {reason?: string}) | options: {reason: "Access requires authentication"} | `Promise<void>`              | Displays the Face ID or Touch ID screen                             |
diff --git a/ios/Plugin/Plugin.swift b/ios/Plugin/Plugin.swift
@@ -16,20 +16,20 @@ public class FaceId: CAPPlugin {
             switch(authContext.biometryType) {
             case .none:
                 call.success([
-                    "value": false
+                    "value": "None"
                 ])
             case .touchID:
                 call.success([
-                    "value": true
+                    "value": "TouchId"
                 ])
             case .faceID:
                 call.success([
-                    "value": true
+                    "value": "FaceId"
                 ])
             }
         } else {
             call.success([
-                "value": false
+                "value": "None"
             ])
         }
     }

diff --git a/src/definitions.ts b/src/definitions.ts
@@ -6,8 +6,8 @@ declare module '@capacitor/core' {
 }
 
 export interface FaceIdPluginIsAvailableResult {
-  /** true if Face ID or Touch ID is available */
-  value: boolean;
+  /**  Returns available biometric type or 'None' if unavailable */
+  value: string;
 }
 
 export interface FaceIdPluginAuthOptions {
@@ -19,7 +19,7 @@ export interface FaceIdPlugin {
   /**
    * check if Face ID or Touch ID is available
    * @returns  {Promise}
-   * @resolve {value: boolean}
+   * @resolve {value: string}
    * @rejects PluginResultError
    */
   isAvailable(): Promise<FaceIdPluginIsAvailableResult>;