简介
heartsuite-client 是一个用于与 Heartsuite 前端套件进行通信的 npm 包，可以通过该包在前端页面上获取 Heartsuite 后端套件中的数据和进行一些操作。该包使用了 WebSocket 技术进行通信，支持对实时数据进行监听。
安装
该包可以通过 npm 进行安装，执行如下命令：
npm install heartsuite-client
使用方法
在前端项目中引入 heartsuite-client：
const HeartsuiteClient = require('heartsuite-client');创建 heartsuiteClient 实例：
-- -------------------- ---- -------
----- ---------------- - --- ------------------
----- ----------------------
----- -
----- ------
------ ----- --- -------
--
------- -
-
----- ---------
--- ------ -- -
--------------------- ---- ---- --------- ------
--
--
-
----- ---------
--- ------ -- -
--------------------- ---- ---- --------- ------
--
--
--
---host 参数指定 Heartsuite 后端套件的地址，auth 参数指定认证信息，topics 参数指定需要监听的主题。每个主题都有一个名称和定义在主题上的监听函数。
发送消息：
heartsuiteClient.sendMessage({
op: 'query',
ql: 'YOUR QUERY LANGUAGE HERE',
}).then((res) => {
console.log('query result:', res);
}).catch((err) => {
console.error('query error:', err);
});sendMessage 方法用于向 Heartsuite 后端套件发送消息，该方法返回一个 Promise。消息体需要包含操作类型（op）和查询语言（ql），具体根据 Heartsuite 中定义的查询语言使用即可。
关闭连接：
heartsuiteClient.close();
在使用完 heartsuiteClient 实例后，需要使用 close 方法关闭连接。
示例代码
-- -------------------- ---- -------
----- ---------------- - -----------------------------
----- ---------------- - --- ------------------
----- ----------------------
----- -
----- ------
------ ----- --- -------
--
------- -
-
----- ---------
--- ------ -- -
--------------------- ---- ---- --------- ------
--
--
--
---
------------------------------
--- --------
--- -- ---------------- --- - -- ---- - ---
------------- -- -
------------------ --------- -----
-------------- -- -
-------------------- -------- -----
---
------------- -- -
-------------------------
-- ------以上示例代码中，创建了一个 heartsuiteClient 实例，其中监听了 topic1 主题，向 Heartsuite 后端套件发送了一个查询操作，查询返回的数据并输出到控制台，并在 3 秒后关闭了连接。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005521e81e8991b448cfa1b