mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-05-20 19:24:11 +08:00
docs(): update docs
This commit is contained in:
parent
acb7cd862d
commit
d92fb1da8b
@ -1,6 +1,23 @@
|
|||||||
import { Cordova, Plugin } from './plugin';
|
import { Cordova, Plugin } from './plugin';
|
||||||
import { Observable } from 'rxjs/Observable';
|
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
|
* @name Httpd
|
||||||
@ -21,6 +38,8 @@ import { Observable } from 'rxjs/Observable';
|
|||||||
* });
|
* });
|
||||||
*
|
*
|
||||||
* ```
|
* ```
|
||||||
|
* @interfaces
|
||||||
|
* HttpdOptions
|
||||||
*/
|
*/
|
||||||
@Plugin({
|
@Plugin({
|
||||||
pluginName: 'Httpd',
|
pluginName: 'Httpd',
|
||||||
@ -40,7 +59,7 @@ export class Httpd {
|
|||||||
observable: true,
|
observable: true,
|
||||||
clearFunction: 'stopServer'
|
clearFunction: 'stopServer'
|
||||||
})
|
})
|
||||||
static startServer(options?: any): Observable<string> { return; }
|
static startServer(options?: HttpdOptions): Observable<string> { return; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the URL of the running server
|
* Gets the URL of the running server
|
||||||
@ -58,23 +77,3 @@ export class Httpd {
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* These options are used for the Httpd.startServer() function.
|
|
||||||
*/
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user