@capgo/capacitor-flash 7.1.1 → 7.1.3

package/README.md

@@ -47,16 +47,20 @@ Works out of the box
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+Capacitor Flash Plugin for controlling device flashlight/torch.
+
 ### isAvailable()
 
 ```typescript
 isAvailable() => Promise<{ value: boolean; }>
 ```
 
-Checks if flashlight is available
+Checks if flashlight is available on the device.
 
 **Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -66,11 +70,13 @@ Checks if flashlight is available
 switchOn(options: { intensity?: number; }) => Promise<void>
 ```
 
-Turns the flashlight on
+Turns the flashlight on.
 
-| Param         | Type                                 |
-| ------------- | ------------------------------------ |
-| **`options`** | <code>{ intensity?: number; }</code> |
+| Param         | Type                                 | Description                                        |
+| ------------- | ------------------------------------ | -------------------------------------------------- |
+| **`options`** | <code>{ intensity?: number; }</code> | - Optional configuration including light intensity |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -81,7 +87,9 @@ Turns the flashlight on
 switchOff() => Promise<void>
 ```
 
-Turns the flashlight off
+Turns the flashlight off.
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -92,10 +100,12 @@ Turns the flashlight off
 isSwitchedOn() => Promise<{ value: boolean; }>
 ```
 
-Checks if the flashlight is turned on or off
+Checks if the flashlight is currently turned on or off.
 
 **Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -105,10 +115,12 @@ Checks if the flashlight is turned on or off
 toggle() => Promise<{ value: boolean; }>
 ```
 
-Toggle the flashlight
+Toggle the flashlight on or off.
 
 **Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -118,10 +130,12 @@ Toggle the flashlight
 getPluginVersion() => Promise<{ version: string; }>
 ```
 
-Get the native Capacitor plugin version
+Get the native Capacitor plugin version.
 
 **Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 </docgen-api>

package/android/src/main/java/ee/forgr/plugin/capacitor_flash/CapacitorFlashPlugin.java

@@ -19,7 +19,7 @@ import com.getcapacitor.annotation.PermissionCallback;
 @CapacitorPlugin(name = "CapacitorFlash", permissions = { @Permission(alias = "camera", strings = { Manifest.permission.CAMERA }) })
 public class CapacitorFlashPlugin extends Plugin {
 
-    private final String PLUGIN_VERSION = "7.1.1";
+    private final String PLUGIN_VERSION = "7.1.3";
 
     private String cameraId;
     boolean isFlashStateOn = false;

package/dist/docs.json

@@ -2,8 +2,13 @@
   "api": {
     "name": "CapacitorFlashPlugin",
     "slug": "capacitorflashplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "Capacitor Flash Plugin for controlling device flashlight/torch.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
     "methods": [
       {
         "name": "isAvailable",
@@ -13,10 +18,22 @@
         "tags": [
           {
             "name": "returns",
-            "text": "true if flashlight is available and false if not"
+            "text": "Promise that resolves with availability status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if checking availability fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { value } = await CapacitorFlash.isAvailable();\nif (value) {\n  console.log('Flashlight is available');\n}\n```"
           }
         ],
-        "docs": "Checks if flashlight is available",
+        "docs": "Checks if flashlight is available on the device.",
         "complexTypes": [],
         "slug": "isavailable"
       },
@@ -26,22 +43,34 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- Optional configuration including light intensity",
             "type": "{ intensity?: number | undefined; }"
           }
         ],
         "returns": "Promise<void>",
         "tags": [
+          {
+            "name": "param",
+            "text": "options - Optional configuration including light intensity"
+          },
           {
             "name": "returns",
-            "text": "an empty Promise"
+            "text": "Promise that resolves when flashlight is turned on"
           },
           {
-            "name": "param",
-            "text": "intensity The intensity of the light between 0.0 and 1.0"
+            "name": "throws",
+            "text": "Error if flashlight is not available or turning on fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Turn on at full brightness\nawait CapacitorFlash.switchOn({ intensity: 1.0 });\n\n// Turn on at half brightness\nawait CapacitorFlash.switchOn({ intensity: 0.5 });\n```"
           }
         ],
-        "docs": "Turns the flashlight on",
+        "docs": "Turns the flashlight on.",
         "complexTypes": [],
         "slug": "switchon"
       },
@@ -52,11 +81,23 @@
         "returns": "Promise<void>",
         "tags": [
           {
-            "name": "rejects",
-            "text": "PluginResultError"
+            "name": "returns",
+            "text": "Promise that resolves when flashlight is turned off"
+          },
+          {
+            "name": "throws",
+            "text": "Error if turning off fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorFlash.switchOff();\n```"
           }
         ],
-        "docs": "Turns the flashlight off",
+        "docs": "Turns the flashlight off.",
         "complexTypes": [],
         "slug": "switchoff"
       },
@@ -68,10 +109,22 @@
         "tags": [
           {
             "name": "returns",
-            "text": "True of flaslight is turned on and false if not"
+            "text": "Promise that resolves with the current flashlight state"
+          },
+          {
+            "name": "throws",
+            "text": "Error if checking state fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { value } = await CapacitorFlash.isSwitchedOn();\nconsole.log('Flashlight is on:', value);\n```"
           }
         ],
-        "docs": "Checks if the flashlight is turned on or off",
+        "docs": "Checks if the flashlight is currently turned on or off.",
         "complexTypes": [],
         "slug": "isswitchedon"
       },
@@ -83,10 +136,22 @@
         "tags": [
           {
             "name": "returns",
-            "text": "True if that worked and false if not"
+            "text": "Promise that resolves with the new flashlight state"
+          },
+          {
+            "name": "throws",
+            "text": "Error if toggling fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { value } = await CapacitorFlash.toggle();\nconsole.log('Flashlight toggled, now on:', value);\n```"
           }
         ],
-        "docs": "Toggle the flashlight",
+        "docs": "Toggle the flashlight on or off.",
         "complexTypes": [],
         "slug": "toggle"
       },
@@ -98,14 +163,22 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with version for this device"
+            "text": "Promise that resolves with the plugin version"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapacitorFlash.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
           }
         ],
-        "docs": "Get the native Capacitor plugin version",
+        "docs": "Get the native Capacitor plugin version.",
         "complexTypes": [],
         "slug": "getpluginversion"
       }

package/dist/esm/definitions.d.ts

@@ -1,43 +1,98 @@
+/**
+ * Capacitor Flash Plugin for controlling device flashlight/torch.
+ *
+ * @since 1.0.0
+ */
 export interface CapacitorFlashPlugin {
     /**
-     * Checks if flashlight is available
-     * @returns  {Promise<{ value: boolean }>} true if flashlight is available and false if not
+     * Checks if flashlight is available on the device.
+     *
+     * @returns Promise that resolves with availability status
+     * @throws Error if checking availability fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { value } = await CapacitorFlash.isAvailable();
+     * if (value) {
+     *   console.log('Flashlight is available');
+     * }
+     * ```
      */
     isAvailable(): Promise<{
         value: boolean;
     }>;
     /**
-     * Turns the flashlight on
-     * @returns {Promise<void>} an empty Promise
-     * @param intensity The intensity of the light between 0.0 and 1.0
+     * Turns the flashlight on.
+     *
+     * @param options - Optional configuration including light intensity
+     * @returns Promise that resolves when flashlight is turned on
+     * @throws Error if flashlight is not available or turning on fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * // Turn on at full brightness
+     * await CapacitorFlash.switchOn({ intensity: 1.0 });
+     *
+     * // Turn on at half brightness
+     * await CapacitorFlash.switchOn({ intensity: 0.5 });
+     * ```
      */
     switchOn(options: {
         intensity?: number;
     }): Promise<void>;
     /**
-     * Turns the flashlight off
-     * @rejects PluginResultError
+     * Turns the flashlight off.
+     *
+     * @returns Promise that resolves when flashlight is turned off
+     * @throws Error if turning off fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * await CapacitorFlash.switchOff();
+     * ```
      */
     switchOff(): Promise<void>;
     /**
-     * Checks if the flashlight is turned on or off
-     * @returns  {Promise<{ value: boolean }>} True of flaslight is turned on and false if not
+     * Checks if the flashlight is currently turned on or off.
+     *
+     * @returns Promise that resolves with the current flashlight state
+     * @throws Error if checking state fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { value } = await CapacitorFlash.isSwitchedOn();
+     * console.log('Flashlight is on:', value);
+     * ```
      */
     isSwitchedOn(): Promise<{
         value: boolean;
     }>;
     /**
-     * Toggle the flashlight
-     * @returns  {Promise<{ value: boolean }>} True if that worked and false if not
+     * Toggle the flashlight on or off.
+     *
+     * @returns Promise that resolves with the new flashlight state
+     * @throws Error if toggling fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { value } = await CapacitorFlash.toggle();
+     * console.log('Flashlight toggled, now on:', value);
+     * ```
      */
     toggle(): Promise<{
         value: boolean;
     }>;
     /**
-     * Get the native Capacitor plugin version
+     * Get the native Capacitor plugin version.
      *
-     * @returns {Promise<{ id: string }>} an Promise with version for this device
-     * @throws An error if the something went wrong
+     * @returns Promise that resolves with the plugin version
+     * @throws Error if getting the version fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { version } = await CapacitorFlash.getPluginVersion();
+     * console.log('Plugin version:', version);
+     * ```
      */
     getPluginVersion(): Promise<{
         version: string;

package/ios/Sources/CapacitorFlashPlugin/CapacitorFlashPlugin.swift

@@ -7,7 +7,7 @@ import Capacitor
  */
 @objc(CapacitorFlashPlugin)
 public class CapacitorFlashPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let PLUGIN_VERSION: String = "7.1.1"
+    private let PLUGIN_VERSION: String = "7.1.3"
     public let identifier = "CapacitorFlashPlugin"
     public let jsName = "CapacitorFlash"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-flash",
-  "version": "7.1.1",
+  "version": "7.1.3",
   "description": "Switch the Flashlight / Torch of your device.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",