mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-14 03:35:08 +08:00
90 lines
2.2 KiB
TypeScript
90 lines
2.2 KiB
TypeScript
import { Injectable } from '@angular/core';
|
|
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
|
import { Observable } from 'rxjs/Observable';
|
|
|
|
export interface HttpdOptions {
|
|
/**
|
|
* The public root directory for your web server. This path is relative to your app's www directory.
|
|
* Default is current directory.
|
|
*/
|
|
www_root?: string;
|
|
/**
|
|
* The port number to use.
|
|
* Default is 8888
|
|
*/
|
|
port?: number;
|
|
/**
|
|
* Setting this option to false will allow remote access to your web server (over any IP).
|
|
* Default is false.
|
|
*/
|
|
localhost_only?: boolean;
|
|
}
|
|
|
|
/**
|
|
* @name Httpd
|
|
* @description
|
|
* Embedded httpd for Cordova apps. Light weight HTTP server.
|
|
* @usage
|
|
* ```typescript
|
|
* import { Httpd, HttpdOptions } from '@ionic-native/httpd';
|
|
*
|
|
* constructor(private httpd: Httpd) { }
|
|
*
|
|
* ...
|
|
*
|
|
*
|
|
* let options: HttpdOptions = {
|
|
* www_root: 'httpd_root', // relative path to app's www directory
|
|
* port: 80,
|
|
* localhost_only: false
|
|
* };
|
|
*
|
|
* this.httpd.startServer(options).subscribe((data) => {
|
|
* console.log('Server is live');
|
|
* });
|
|
*
|
|
* ```
|
|
* @interfaces
|
|
* HttpdOptions
|
|
*/
|
|
@Plugin({
|
|
pluginName: 'Httpd',
|
|
plugin: 'cordova-plugin-httpd',
|
|
pluginRef: 'cordova.plugins.CorHttpd',
|
|
repo: 'https://github.com/floatinghotpot/cordova-httpd',
|
|
platforms: ['Android', 'iOS', 'macOS']
|
|
})
|
|
@Injectable()
|
|
export class Httpd extends IonicNativePlugin {
|
|
/**
|
|
* Starts a web server.
|
|
* @param options {HttpdOptions}
|
|
* @returns {Observable<string>} Returns an Observable. Subscribe to receive the URL for your web server (if succeeded). Unsubscribe to stop the server.
|
|
*/
|
|
@Cordova({
|
|
observable: true,
|
|
clearFunction: 'stopServer'
|
|
})
|
|
startServer(options?: HttpdOptions): Observable<string> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Gets the URL of the running server
|
|
* @returns {Promise<string>} Returns a promise that resolves with the URL of the web server.
|
|
*/
|
|
@Cordova()
|
|
getUrl(): Promise<string> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Get the local path of the running webserver
|
|
* @returns {Promise<string>} Returns a promise that resolves with the local path of the web server.
|
|
*/
|
|
@Cordova()
|
|
getLocalPath(): Promise<string> {
|
|
return;
|
|
}
|
|
}
|