npm 包 heartsuite-client 使用教程

简介

heartsuite-client 是一个用于与 Heartsuite 前端套件进行通信的 npm 包,可以通过该包在前端页面上获取 Heartsuite 后端套件中的数据和进行一些操作。该包使用了 WebSocket 技术进行通信,支持对实时数据进行监听。

安装

该包可以通过 npm 进行安装,执行如下命令:

--- ------- -----------------

使用方法

在前端项目中引入 heartsuite-client

----- ---------------- - -----------------------------

创建 heartsuiteClient 实例:

----- ---------------- - --- ------------------
  ----- ----------------------
  ----- -
    ----- ------
    ------ ----- --- -------
  --
  ------- -
    -
      ----- ---------
      --- ------ -- -
        --------------------- ---- ---- --------- ------
      --
    --
    -
      ----- ---------
      --- ------ -- -
        --------------------- ---- ---- --------- ------
      --
    --
  --
---

host 参数指定 Heartsuite 后端套件的地址,auth 参数指定认证信息,topics 参数指定需要监听的主题。每个主题都有一个名称和定义在主题上的监听函数。

发送消息:

------------------------------
  --- --------
  --- ----- ----- -------- ------
------------- -- -
  ------------------ --------- -----
-------------- -- -
  -------------------- -------- -----
---

sendMessage 方法用于向 Heartsuite 后端套件发送消息,该方法返回一个 Promise。消息体需要包含操作类型(op)和查询语言(ql),具体根据 Heartsuite 中定义的查询语言使用即可。

关闭连接:

-------------------------

在使用完 heartsuiteClient 实例后,需要使用 close 方法关闭连接。

示例代码

----- ---------------- - -----------------------------

----- ---------------- - --- ------------------
  ----- ----------------------
  ----- -
    ----- ------
    ------ ----- --- -------
  --
  ------- -
    -
      ----- ---------
      --- ------ -- -
        --------------------- ---- ---- --------- ------
      --
    --
  --
---

------------------------------
  --- --------
  --- -- ---------------- --- - -- ---- - ---
------------- -- -
  ------------------ --------- -----
-------------- -- -
  -------------------- -------- -----
---

------------- -- -
  -------------------------
-- ------

以上示例代码中,创建了一个 heartsuiteClient 实例,其中监听了 topic1 主题,向 Heartsuite 后端套件发送了一个查询操作,查询返回的数据并输出到控制台,并在 3 秒后关闭了连接。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005521e81e8991b448cfa1b


猜你喜欢

  • npm 包 express-rc 使用教程

    前言 在前端项目中,我们经常需要使用到后端服务,而使用 Node.js 作为后端服务的工具,经常使用的框架之一便是 Express。而在使用 Express 进行开发时,deploy 和 test 常...

    2 年前
  • npm 包 offgrid-components 使用教程

    前言 在前端开发中,我们需要使用各种前端库和框架来提高开发效率和代码可维护性。其中,npm 是一个非常重要的工具,它可以帮助我们快速查找和安装各种开源的前端库和框架。

    2 年前
  • npm 包 gulp-akamaiweb 使用教程

    前言 在前端开发中,我们经常会用到 gulp 来管理项目,同时我们也经常会用到 Akamai CDN 来加速网站。而 gulp-akamaiweb 便是一个可以将前端资源(js、css、img等)上传...

    2 年前
  • npm 包 env-regex 使用教程

    简介 环境变量是前端应用中常用的配置方式之一,而在不同的环境中配置变量常常是一个麻烦的事情。npm 包 env-regex 可以方便地从环境变量中获取到需要的配置信息,并在应用中使用。

    2 年前
  • npm 包 node-red-contrib-madlib 使用教程

    前言 Node-RED 是一个流程编程工具,使得可以通过流程来编写应用程序。其中,npm 包 node-red-contrib-madlib 是一款非常好用的 Node-RED 扩展包,它提供了一套序...

    2 年前
  • npm 包 create-rrr-app 使用教程

    引言 在构建一个 React 项目时,我们经常会遇到一些重复性的工作,如创建项目架构、配置 webpack 或者 babel 等。为了能够提高这些工作的效率,有一个方便的工具可以帮助我们一键完成这些繁...

    2 年前
  • npm 包 feathers-js-data 使用教程

    前言 在前端开发的过程中,操作数据是非常常见的。同时,我们还希望代码尽可能简洁和易于维护。在这样的背景下,feathers-js-data 库应运而生。它提供了一个简洁的 API,帮助前端开发者轻松地...

    2 年前
  • npm 包 kini-naru-enums 使用教程

    kini-naru-enums 是一个基于 JavaScript 的 npm 包,用于创建枚举对象。它可以帮助前端开发人员快速方便地创建和使用枚举对象。本文将详细介绍如何使用这个 npm 包以及它的内...

    2 年前
  • npm 包 little-brother-setup 使用教程

    在前端开发中,使用 npm 包管理工具已经成为了家常便饭。而选择合适的 npm 包,对于提高项目效率和开发体验,也非常重要。今天,我们将要介绍的是一个小巧的 npm 包:little-brother-...

    2 年前
  • npm 包 `eslint-plugin-nodejs` 使用教程

    什么是 eslint-plugin-nodejs? eslint-plugin-nodejs 是一个 ESLint 插件,它提供了一些针对 Node.js 代码的特定的规则和配置,用于提高代码质量和可...

    2 年前
  • npm 包 n-array 使用教程

    前言 在前端开发中,经常需要对数据进行数组操作。n-array 是一个方便数组操作的 npm 包,它提供了一系列功能强大的方法,如:过滤、排序、分组等,使我们可以轻松地对数组进行各种操作。

    2 年前
  • npm 包 nd-array 使用教程

    在前端领域,我们经常需要处理数据,例如二维矩阵、三维模型等。这时候,一个高效的数据处理工具就显得非常重要了。而 npm 包 nd-array 正是一款可以帮助我们快速高效处理数据的工具。

    2 年前
  • npm 包 xml-edit 使用教程

    前言 在前端开发中,经常需要对 XML 数据进行解析和编辑。为了方便开发,社区提供了许多优秀的 npm 包来满足开发需求,其中一款叫做 xml-edit 的 npm 包可以帮助我们更方便地编辑 XML...

    2 年前
  • npm 包 lazy-differ 使用教程

    作为前端开发人员,我们不仅要编写代码,还需要保证代码的可维护性和可扩展性。而其中一个关键点就是如何优化代码的效率和性能。而 npm 包 lazy-differ 就是一个能够帮助我们解决这个问题的工具。

    2 年前
  • npm 包 teambot-hello 使用教程

    teambot-hello 是一个简单的 npm 包,它通过命令行输出 "Hello, Team Bot!" 的字符串来向使用者打招呼。这个包非常易于使用,不需要任何配置,可以让你在几秒钟内开始使用。

    2 年前
  • npm 包 win-query-utils 使用教程

    背景 在前端开发中,我们经常需要通过 JavaScript 操作 DOM 元素,进行诸如查询元素,修改元素属性,监听事件等常见操作。为了方便开发者进行这些操作,我们可以利用一个开源工具包,即 npm ...

    2 年前
  • npm 包 write-pad 使用教程

    简介 write-pad 是一个 node.js 的模块,主要用于在前端页面中创建一个可编辑的文本框。 安装 安装 write-pad 非常简单,只需要在命令行中执行以下命令: --- -------...

    2 年前
  • NPM 包 redux-object-connect 使用教程

    Redux 是一种非常流行的 JavaScript 应用程序状态管理系统,它可以协调一个应用程序的数据流,并把应用程序的状态集中化处理。Redux 像是一个被全局使用的“状态仓库”,它存储了应用程序的...

    2 年前
  • npm 包 @micahhausler/newrelic 使用教程

    简介 在前端开发中,我们常常需要对网站或者应用程序进行监测和优化,以达到更好的用户体验。这时,New Relic 就发挥了非常重要的作用。New Relic 是一家提供应用性能管理 (Applicat...

    2 年前
  • npm 包 asteroid-isme2n 使用教程

    1. 背景介绍 在前端开发过程中,我们经常需要使用众多的第三方应用来解决问题,其中的一种是 Asteroid 提供的面向 DDP 协议的客户端库。该库允许我们使用 JavaScript 来连接 Met...

    2 年前

相关推荐

    暂无文章