docs(): update docs

This commit is contained in:
Ibby 2016-12-06 09:15:03 -05:00
parent acb7cd862d
commit d92fb1da8b

View File

@ -1,6 +1,23 @@
import { Cordova, Plugin } from './plugin';
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
@ -21,6 +38,8 @@ import { Observable } from 'rxjs/Observable';
* });
*
* ```
* @interfaces
* HttpdOptions
*/
@Plugin({
pluginName: 'Httpd',
@ -40,7 +59,7 @@ export class Httpd {
observable: true,
clearFunction: 'stopServer'
})
static startServer(options?: any): Observable<string> { return; }
static startServer(options?: HttpdOptions): Observable<string> { return; }
/**
* 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;
}