@liquid-state/docviewer - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

dist/docs.json

@@ -14,3 +14,3 @@ {
             "name": "options",
-            "docs": "",
+            "docs": "value to echo back (no ui)",
             "type": "{ value: string; }"
@@ -20,4 +20,9 @@ }
         "returns": "Promise<{ value: string; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options value to echo back (no ui)"
+          }
+        ],
+        "docs": "Useless api that can be used to test the plugin",
         "complexTypes": [],
@@ -32,3 +37,3 @@ "slug": "echo"
             "name": "options",
-            "docs": "",
+            "docs": "name, page_slug and config",
             "type": "{ name: string; page_slug?: string | undefined; config?: {} | undefined; }"
@@ -38,4 +43,9 @@ }
         "returns": "Promise<{ viewer_id: string; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options name, page_slug and config"
+          }
+        ],
+        "docs": "Launch a built-in document using it's base file name (note: this is just the file name, not path)",
         "complexTypes": [],
@@ -50,3 +60,3 @@ "slug": "launchnameddocument"
             "name": "options",
-            "docs": "",
+            "docs": "url, page_slug and config",
             "type": "{ url: string; page_slug?: string | undefined; config?: {} | undefined; }"
@@ -56,6 +66,21 @@ }
         "returns": "Promise<{ viewer_id: string; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options url, page_slug and config"
+          }
+        ],
+        "docs": "Launch a document using a local (on ios: file, on android: content) url",
+        "complexTypes": [],
+        "slug": "launchdocument"
+      },
+      {
+        "name": "closeViewerIfAny",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
         "tags": [],
-        "docs": "",
+        "docs": "Close any currently open document viewer",
         "complexTypes": [],
-        "slug": "launchdocument"
+        "slug": "closeviewerifany"
       }
@@ -62,0 +87,0 @@ ],

dist/esm/definitions.d.ts

 export interface DocviewerPlugin {
+    /**
+     * Useless api that can be used to test the plugin
+     * @param options value to echo back (no ui)
+     */
     echo(options: {
@@ -7,2 +11,6 @@ value: string;
     }>;
+    /**
+     * Launch a built-in document using it's base file name (note: this is just the file name, not path)
+     * @param options name, page_slug and config
+     */
     launchNamedDocument(options: {
@@ -15,2 +23,6 @@ name: string;
     }>;
+    /**
+     * Launch a document using a local (on ios: file, on android: content) url
+     * @param options url, page_slug and config
+     */
     launchDocument(options: {
@@ -23,2 +35,6 @@ url: string;
     }>;
+    /**
+     * Close any currently open document viewer
+     */
+    closeViewerIfAny(): Promise<void>;
 }

dist/esm/web.d.ts

@@ -23,2 +23,3 @@ import { WebPlugin } from '@capacitor/core';
     }>;
+    closeViewerIfAny(): Promise<void>;
 }

dist/esm/web.js

@@ -15,3 +15,6 @@ import { WebPlugin } from '@capacitor/core';
     }
+    async closeViewerIfAny() {
+        console.log('closeViewerIfAny');
+    }
 }
 //# sourceMappingURL=web.js.map

dist/plugin.cjs.js

@@ -24,2 +24,5 @@ 'use strict';
     }
+    async closeViewerIfAny() {
+        console.log('closeViewerIfAny');
+    }
 }
@@ -26,0 +29,0 @@

dist/plugin.js

@@ -21,2 +21,5 @@ var capacitorDocviewer = (function (exports, core) {
         }
+        async closeViewerIfAny() {
+            console.log('closeViewerIfAny');
+        }
     }
@@ -23,0 +26,0 @@

package.json

 {
   "name": "@liquid-state/docviewer",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Plugin to launch and run the Liquid State Document Viewer",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

README.md

@@ -19,2 +19,3 @@ # @liquid-state/docviewer
 * [`launchDocument(...)`](#launchdocument)
+* [`closeViewerIfAny()`](#closeviewerifany)
 
@@ -32,6 +33,8 @@ </docgen-index>
 
-| Param         | Type                            |
-| ------------- | ------------------------------- |
-| **`options`** | <code>{ value: string; }</code> |
+Useless api that can be used to test the plugin
 
+| Param         | Type                            | Description                |
+| ------------- | ------------------------------- | -------------------------- |
+| **`options`** | <code>{ value: string; }</code> | value to echo back (no ui) |
+
 **Returns:** <code>Promise&lt;{ value: string; }&gt;</code>
@@ -48,6 +51,8 @@
 
-| Param         | Type                                                            |
-| ------------- | --------------------------------------------------------------- |
-| **`options`** | <code>{ name: string; page_slug?: string; config?: {}; }</code> |
+Launch a built-in document using it's base file name (note: this is just the file name, not path)
 
+| Param         | Type                                                            | Description                |
+| ------------- | --------------------------------------------------------------- | -------------------------- |
+| **`options`** | <code>{ name: string; page_slug?: string; config?: {}; }</code> | name, page_slug and config |
+
 **Returns:** <code>Promise&lt;{ viewer_id: string; }&gt;</code>
@@ -64,6 +69,8 @@
 
-| Param         | Type                                                           |
-| ------------- | -------------------------------------------------------------- |
-| **`options`** | <code>{ url: string; page_slug?: string; config?: {}; }</code> |
+Launch a document using a local (on ios: file, on android: content) url
 
+| Param         | Type                                                           | Description               |
+| ------------- | -------------------------------------------------------------- | ------------------------- |
+| **`options`** | <code>{ url: string; page_slug?: string; config?: {}; }</code> | url, page_slug and config |
+
 **Returns:** <code>Promise&lt;{ viewer_id: string; }&gt;</code>
@@ -73,2 +80,13 @@
 
+
+### closeViewerIfAny()
+
+```typescript
+closeViewerIfAny() => Promise<void>
+```
+
+Close any currently open document viewer
+
+--------------------
+
 </docgen-api>

No alert changes

Improved metrics

Total package byte prevSize

73737

increased by6.42%

Lines of code

237

increased by27.42%

Number of lines in readme file

88

increased by25.71%

No dependency changes