From d92fb1da8b92843a79853789f14ac31a487b2768 Mon Sep 17 00:00:00 2001 From: Ibby Date: Tue, 6 Dec 2016 09:15:03 -0500 Subject: [PATCH] docs(): update docs --- src/plugins/httpd.ts | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/src/plugins/httpd.ts b/src/plugins/httpd.ts index 59bfbd53..91947742 100644 --- a/src/plugins/httpd.ts +++ b/src/plugins/httpd.ts @@ -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 { return; } + static startServer(options?: HttpdOptions): Observable { 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; -}