cordova-serve中文文档|cordova-serve js中文教程|解析

npm npmdoc 2年前 (2021-12-31) 369次浏览

cordova-serve中文文档|cordova-serve js中文教程|解析

安装命令:npm i cordova-serve

cordova-serve

新产品管理

节点 CI

该模块提供了一个 JavaScript API,用于在浏览器中提供 Cordova 应用程序。

API 示例:

const cordovaServe = require('cordova-serve')();
 
cordovaServe.launchServer(options);
cordovaServe.servePlatform(platform, options);
cordovaServe.launchBrowser(options);

API 方法

launchServer()

启动本地 HTTP 服务器。

代码示例:

const cordovaServe = require('cordova-serve')();
 
cordovaServe.launchServer(options).then(function () {
    const { server, port, root } = cordovaServe;
    ...
}, error => {
    console.log(`An error occurred: ${error}`);
});

参数:

  • options:在下面的“ launchServer & servePlatform Options部分中进行了描述

返回:

根据服务器是否成功启动,返回已解决或拒绝的承诺。

对于已履行的承诺,返回的对象具有以下属性:

财产 描述
serve 节点http.Server实例。
root root所指定,或者cwd如果没有指定。
port 使用的端口。(请求的端口、 的默认端口8000或所选端口已被使用时所选端口的递增值)。

servePlatform()

推出该服务的任何科尔多瓦平台服务器(例如browserandroid等)从当前项目。

代码示例:

const cordovaServe = require('cordova-serve')();
 
cordovaServe.servePlatform(platform, options).then(() => {
    const { server, port, projectRoot, root } = cordovaServe;
    ...
}, error => {
    console.log(`An error occurred: ${error}`);
});

参数:

  • options:在下面的“ launchServer & servePlatform Options部分中进行了描述

返回:

请注意,对于servePlatform(),该root值应该是 Cordova 项目的根文件夹或其中的任何文件夹。servePlatform()将其替换为平台的www_dir文件夹。如果未指定此值,则将使用cwd

根据服务器是否成功启动,返回已解决或拒绝的承诺。

对于已履行的承诺,返回的对象具有以下属性:

财产 描述
serve 节点http.Server实例。
root 请求平台的www文件夹。
projectRoot Cordova 项目的根文件夹。
port 使用的端口。请求的端口、默认端口8000或已使用时所选端口的递增值)。

launchBrowser()

启动指向指定 URL 的浏览器窗口。

代码示例:

const cordovaServe = require('cordova-serve')();
 
cordovaServe.launchBrowser(options).then(
  stdout => {
    console.log(`Browser was launched successfully: ${stdout}`);
  },
  error => {
    console.log(`An error occurred: ${error}`);
  }
);

参数:

  • 选项(可选):
选项 描述
url 要在浏览器中打开的 URL。
target 要启动的浏览器标识符。有效的标识符chromechromiumfirefoxieoperasafari默认: chrome。)

返回:

根据浏览器是否成功启动,返回已解决或拒绝的承诺。

启动服务器和服务平台选项

options传递给launchServer()servePlatform()支持以下值对象(都是可选的):

选项 描述
root 用作服务器根的本地文件系统上的文件路径,用于将 URL 路径默认映射到本地文件系统路径。
port 服务器的端口。请注意,如果此端口已在使用中,它将递增,直到找到可用端口。
router 一个ExpressJS路由器。如果提供,这将默认静态处理之前附加
noLogOutput 如果为 true,将关闭所有日志输出。
noServerInfo 如果trueStatic file server running on...则不会输出消息。
events 一个EventEmitter用于记录。如果提供,日志将使用events.emit('log', msg). 如果未提供,console.log()将被使用。请注意,如果noLogOutputis ,则在任何一种情况下都不会输出任何内容true

极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:cordova-serve中文文档|cordova-serve js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}