Skip to content

feat(plugins): add web-server plugin #2726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 25, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions src/@ionic-native/plugins/web-server/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Observable } from 'rxjs/Observable';

export interface Response {
status: number;
body: string;
headers: { [key: string]: string};
}

export interface Request {
requestId: string;
body: string;
headers: string;
method: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE';
path: string;
query: string;
}

/**
* @name Web Server
* @description
* This plugin allows you to start a local dynamic content web server for android and iOS devices.
*
* @usage
* ```typescript
* import { WebServer } from '@ionic-native/web-server';
*
*
* constructor(private webServer: WebServer) { }
*
* ...
*
* this.webServer.onRequest().subscribe(data => {
* console.log(data);
* const res: Response = {
* status: 200,
* body: '',
* headers: {
* 'Content-Type': 'text/html'
* }
* };
*
* this.webServer.sendResponse(data.requestId, res)
* .catch((error: any) => console.error(error));
* });
*
* this.webServer.start(80)
* .catch((error: any) => console.error(error));
*
* ```
*
* @interfaces
* Response
* Request
*/
@Plugin({
pluginName: 'WebServer',
plugin: 'cordova-plugin-webserver',
pluginRef: 'window.webserver',
repo: 'https://github.com/bykof/cordova-plugin-webserver.git',
platforms: ['Android', 'iOS']
})
@Injectable()
export class WebServer extends IonicNativePlugin {

/**
* This method will start your webserver.
* @param port {number} Port number (default to 8080)
*/
@Cordova({
callbackOrder: 'reverse',
})
start(port?: number): Promise<any> {
return;
}

/**
* This method will stop your webserver.
*/
@Cordova()
stop(): Promise<any> {
return;
}

/**
* This method returns an observable that streams HTTP requests to an observer.
* @return {Observable<Request>} Returns an observable to resolve as a Request object
*/
@Cordova({
callbackOrder: 'reverse',
observable: true,
clearFunction: 'stop'
})
onRequest(): Observable<Request> {
return;
}

/**
* This method sends a response to a request.
* @param requestId {string} Request ID to respond to
* @param responseObject {Response} Response object
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
sendResponse(requestId: string, responseObject: Response): Promise<any> {
return;
}

}