API 参考

提示

提示: 在使用HTML一键打包EXE工具提供的API之前, 您需要在打包时的高级配置页面勾选上开启API支持, 如下图所示:

机器码API

机器码API可以用于实现自己的认证逻辑

window.HTMLPackHelper.machineCode

窗口控制API

最大化窗口

window.HTMLPackHelper.maximize()

最小化窗口

window.HTMLPackHelper.minimize()

恢复窗口大小

window.HTMLPackHelper.restore()

关闭应用

window.HTMLPackHelper.close()

切换全屏状态API

window.HTMLPackHelper.toggleFullscreen()

返回主页API

window.HTMLPackHelper.backToHomePage()

打开运行本地文件API

window.HTMLPackHelper.open(path)

其中path为本地文件路径,支持相对路径和绝对路径

例如:

window.HTMLPackHelper.open("C:/Windows/notepad.exe")    //打开记事本

window.HTMLPackHelper.open("my.docx")    //打开exe所在目录的my.docx文件

打开调试窗口

window.HTMLPackHelper.openDebug()

本地存储API

获取当前存储数据的大小(单位字节)

window.HTMLPackHelper.getStorageSize()

获取数据

window.HTMLPackHelper.get(key) // key为字符串

写入数据

window.HTMLPackHelper.set(key, value) //key为字符串,value为要保存的字符串的值

清除所有数据

window.HTMLPackHelper.clear()

获取剪切板字符串API

window.HTMLPackHelper.getClipboardString() //返回剪切板的字符串

闪烁窗口API:

开始闪烁：

window.HTMLPackHelper.flashWindow();

停止闪烁：

window.HTMLPackHelper.stopFlashWindow();

清理缓存API:

window.HTMLPackHelper.clearAllCache();

关闭计算机API

window.HTMLPackHelper.shutdownSystem(); // 调用后可以关闭电脑

获取唯一机器码:

window.HTMLPackHelper.getUniqueMachineCode();//调用后可获取唯一机器码，相比机器码API更加稳定

浏览器打开网址API：

window.HTMLPackHelper.openUrlInBrowser("https://www.baidu.com");

退出回调API:

window.HTMLPackHelper.onQuit = ()=>{

  // 你的业务逻辑  
  // return false: 处理完成后不关闭程序  
  // return true: 处理完成后关闭程序  
  return false;  
}

获取Mac地址API:

打包的时候勾选启用API, 然后在HTML页面里，即可获取电脑的Mac地址信息： 

// 返回结果类似 0b:00:28:00:00:0c
window.HTMLPackHelper.getMac()

串口通信API:

获取SerialPort类示例代码如下：

const SerialPort = HTMLPackHelper.getSerialPort().SerialPort;

详细使用说明可以参考如下文档：

SerialPort Usage | Node SerialPort

上位机使用JS SerialPort进行串口通信， 包含开发环境搭建和完整示例代码 - H5开发技术 - 博客园 (cnblogs.com)

获取命令行参数：

HTMLPackerHelper.getArgv()

返回结果是一个array, 其中第一个值是当前EXE所在的路径，后续的值即为打开EXE所使用的命令行参数， 如下图所示

读写文件api

// 获取用户目录下的dd.ini文件, 如果不存在则会抛出异常

const content = HTMLPackHelper.getFileContent("dd.ini")

// 获取用户目录下的dd.ini文件, 如果不存在则会返回default

const content = HTMLPackHelper.getFileContent("dd.ini", "default")

// 向用户目录的dd.ini文件写入"ddd"

HTMLPackHelper.writeFileContent("dd.ini", "ddd")