feat(GCDWebServer): add plugin (#4302)

* add GCDWebServer * fix plugin ref and add the server options interface * fix the pluginRef's case * update name * add docs
danielsogl · Oct 9, 2022 · f8c6430 · f8c6430
1 parent 98dc7c4
commit f8c6430
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 0 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -216,6 +216,7 @@
  * [Printer](plugins/printer.md)
  * [Browser Tab](plugins/browser-tab.md)
  * [Dynamsoft Barcode Scanner](plugins/dynamsoft-barcode-scanner.md)
+ * [GCDWebServer](plugins/gcdwebserver.md)
 * [Installation](installation.md)
 * [FAQ](faq.md)
 
diff --git a/docs/plugins/gcdwebserver.md b/docs/plugins/gcdwebserver.md
@@ -0,0 +1,19 @@
+# GCDWebServer
+
+```
+$ ionic cordova plugin add cordova-plugin-gcdwebserver
+$ npm install @awesome-cordova-plugins/gcdwebserver
+```
+
+## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/gcdwebserver/)
+
+Plugin Repo: [https://github.com/xulihang/cordova-plugin-gcdwebserver](https://github.com/xulihang/cordova-plugin-gcdwebserver)
+
+The [GCDWebServer](https://github.com/swisspol/GCDWebServer/) Plugin can start an HTTP server to serve static files.
+
+## Supported platforms
+
+iOS
+
+
+
diff --git a/docs/plugins/gcdwebserver/README.md b/docs/plugins/gcdwebserver/README.md
@@ -0,0 +1,19 @@
+# GCDWebServer
+
+```
+$ ionic cordova plugin add cordova-plugin-gcdwebserver
+$ npm install @awesome-cordova-plugins/gcdwebserver
+```
+
+## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/gcdwebserver/)
+
+Plugin Repo: [https://github.com/xulihang/cordova-plugin-gcdwebserver](https://github.com/xulihang/cordova-plugin-gcdwebserver)
+
+The [GCDWebServer](https://github.com/swisspol/GCDWebServer/) Plugin can start an HTTP server to serve static files.
+
+## Supported platforms
+
+iOS
+
+
+
diff --git a/src/@awesome-cordova-plugins/plugins/gcdwebserver/index.ts b/src/@awesome-cordova-plugins/plugins/gcdwebserver/index.ts
@@ -0,0 +1,69 @@
+import { Injectable } from '@angular/core';
+import {
+ Plugin,
+ Cordova,
+ CordovaProperty,
+ CordovaInstance,
+ InstanceProperty,
+ AwesomeCordovaNativePlugin,
+} from '@awesome-cordova-plugins/core';
+
+export interface ServerOptions {
+ port?: number;
+ folder?: string;
+}
+
+/**
+ * @name gcdwebserver
+ * @description
+ * This plugin can start an HTTP server using GCDWebServer
+ *
+ * @usage
+ * ```typescript
+ * import { GCDWebServer } from '@awesome-cordova-plugins/gcdwebserver';
+ *
+ *
+ * constructor(private gcdwebserver: GCDWebServer) { }
+ *
+ * ...
+ *
+ *
+ * await this.gcdwebserver.startServer({});
+ * 
+ *
+ * ```
+ */
+@Plugin({
+ pluginName: 'gcdwebserver',
+ plugin: 'cordova-plugin-gcdwebserver',
+ pluginRef: 'cordova.plugins.GCDServer',
+ repo: 'https://github.com/xulihang/cordova-plugin-gcdwebserver',
+ install: '',
+ installVariables: [],
+ platforms: ['iOS'],
+})
+@Injectable()
+export class GCDWebServer extends AwesomeCordovaNativePlugin {
+ /**
+ * start the server
+ * @param options {ServerOptions}
+ * @return {Promise<any>} Returns a promise
+ */
+ @Cordova({
+ successIndex: 1,
+ errorIndex: 2
+ })
+ startServer(options: ServerOptions): Promise<any> {
+ return;
+ }
+
+ /**
+ * stop the server
+ * @return {Promise<any>} Returns a promise
+ */
+ @Cordova({ successIndex: 1, errorIndex: 2 })
+ stopServer(): Promise<any> {
+ return;
+ }
+
+}