npm 包 what-app 使用教程

阅读时长 4 分钟读完

前端开发中常常需要将数据以通知、消息等形式展示给用户,而 what-app 是一个基于 web 的通知工具包,可以方便地实现各种通知方式。本文将介绍 what-app 的使用方法,包括安装、配置以及基本的 API 调用等。

安装

使用 npm 安装 what-app:

配置

使用 what-app 首先需要配置各种服务提供商的 API,下面以实现微信、钉钉、邮件通知为例进行说明。

微信配置

首先需要在微信公众平台中创建应用,获取 AppID 和 AppSecret。

在应用中打开“开发”->“基本配置”,配置好服务器地址和 Token,提交后开启开发者模式。

接着在代码中使用以下代码进行微信的配置:

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

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

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

钉钉配置

首先需要在钉钉开放平台中创建企业应用,获取 AgentId、CorpId 和 CorpSecret。

在应用中打开“基础配置”,配置好服务器地址和 Token 和加密配置,提交后开启事件订阅。

接着在代码中使用以下代码进行钉钉的配置:

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

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

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

邮件配置

邮件通知可以使用 nodemailer 实现,需要在代码中添加以下配置:

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

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

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

使用

以上配置完成后,即可使用 what-app 的 API 进行通知。

发送文本消息

使用 notify 方法即可发送文本消息:

发送链接消息

使用 link 方法即可发送链接消息:

发送图片消息

使用 image 方法即可发送图片消息:

发送图文消息

使用 articles 方法即可发送图文消息:

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

总结

通过本文的介绍,我们可以了解到 what-app 的基本用法,包括安装、配置和 API 调用等。what-app 可以方便地实现各种通知方式,为前端开发提供了非常有价值的工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671098dd3466f61ffe001

纠错
反馈