Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/cordova-serve
Apache Cordova Serve Library
https://github.com/apache/cordova-serve
cordova hacktoberfest javascript mobile nodejs
Last synced: 1 day ago
JSON representation
Apache Cordova Serve Library
- Host: GitHub
- URL: https://github.com/apache/cordova-serve
- Owner: apache
- License: apache-2.0
- Created: 2016-11-28T08:00:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T14:53:07.000Z (9 months ago)
- Last Synced: 2024-05-22T16:38:59.323Z (7 months ago)
- Topics: cordova, hacktoberfest, javascript, mobile, nodejs
- Language: JavaScript
- Homepage: https://cordova.apache.org/
- Size: 659 KB
- Stars: 21
- Watchers: 16
- Forks: 31
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# cordova-serve
[](https://nodei.co/npm/cordova-serve/)
[](https://github.com/apache/cordova-serve/actions?query=branch%3Amaster)
This module provides a JavaScript API to serve up a Cordova application in the browser.
**API Example:**
```js
const cordovaServe = require('cordova-serve')();
cordovaServe.launchServer(options);
cordovaServe.servePlatform(platform, options);
cordovaServe.launchBrowser(options);
```
## API Methods
### `launchServer()`
Launches a local HTTP server.
**Code Example:**
```js
const cordovaServe = require('cordova-serve')();
cordovaServe.launchServer(options).then(function () {
const { server, port, root } = cordovaServe;
...
}, error => {
console.log(`An error occurred: ${error}`);
});
```
**Parameters:**
* **options**: described below in the following section "**launchServer & servePlatform Options**".
**Return:**
Returns a resolved or rejected promise depending on if the server had launched successfully.
On a fulfilled promise, the following properties are available on the returned object:
Property | Description
-|-
`serve` | The Node `http.Server` instance.
`root` | The `root` that was specified, or `cwd` if none specified.
`port` | The port that was used. (Either the requested port, the default port of `8000`, or the incremented value of the chosen port when the chosen port is already in use).
## `servePlatform()`
Launches a server that serves up any Cordova platform (e.g. `browser`, `android`, etc) from the current project.
**Code Example:**
```js
const cordovaServe = require('cordova-serve')();
cordovaServe.servePlatform(platform, options).then(() => {
const { server, port, projectRoot, root } = cordovaServe;
...
}, error => {
console.log(`An error occurred: ${error}`);
});
```
**Parameters:**
* **options**: described below in the following section "**launchServer & servePlatform Options**".
**Return:**
Note that for `servePlatform()`, the `root` value should be a Cordova project's root folder or any folder within it. `servePlatform()` will replace it with the platform's `www_dir` folder. If this value is not specified, the *cwd* will be used.
Returns a resolved or rejected promise depending on if the server had launched successfully.
On a fulfilled promise, the following properties are available on the returned object:
Property | Description
-|-
`serve` | The Node `http.Server` instance.
`root` | The requested platform's `www` folder.
`projectRoot` | The root folder of the Cordova project.
`port` | The used port. requested port, the default port `8000`, or incremented value of the chosen port when already in use).
### `launchBrowser()`
Launches a browser window pointing to the specified URL.
**Code Example:**
```js
const cordovaServe = require('cordova-serve')();
cordovaServe.launchBrowser(options).then(
stdout => {
console.log(`Browser was launched successfully: ${stdout}`);
},
error => {
console.log(`An error occurred: ${error}`);
}
);
```
**Parameters:**
* **options** (optional):
Options | Description
-|-
`url` | The URL to open in the browser.
`target` | The browser identifier to launch. **Valid identifier**: `chrome`, `chromium`, `firefox`, `ie`, `opera`, `safari`. (**Default:** `chrome`.)
**Return:**
Returns a resolved or rejected promise depending on if the browser had launched successfully.
## launchServer & servePlatform Options
The `options` object passed to `launchServer()` and `servePlatform()` supports the following values (all optional):
Options | Description
-|-
`root` | The file path on the local file system that is used as the root for the server, for default mapping of URL path to the local file system path.
`port` | The port for the server. Note that if this port is already in use, it will be incremented until a free port is found.
`router` | An `ExpressJS` router. If provided, this will be attached *before* default static handling.
`noLogOutput` | If true, all log output will be turned off.
`noServerInfo` | If `true`, the `Static file server running on...` message will not be outputed.
`events` | An `EventEmitter` to use for logging. If provided, logging will be output using `events.emit('log', msg)`. If not provided, `console.log()` will be used. Note that nothing will be output in either case if `noLogOutput` is `true`.