npm 包 apology-middleware 使用教程

阅读时长 4 分钟读完

前言

网站开发过程中,用户反馈是非常重要的一环。但是我们难以避免一些不可抗因素导致用户遭受到不良体验,如果能够及时向用户发出道歉和解释,对恢复用户的信任至关重要。而 apology-middleware 包就提供了一种实现较为简便的方式。

什么是 apology-middleware

apology-middleware 是一个 Node.js 中间件,当网站出现问题导致用户遭受到不良体验时,可以通过它向用户展示一条自定义的道歉信息。这条信息会被渲染成一个 HTML 页面,并且完全可定制化。

安装

使用 npm 安装:

使用

在 Express 中使用:

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

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

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

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

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

当访问网站时,如果网站出现问题,将自动展示 apology 中间件中设置的道歉信息。如下图:

配置

apology() 函数接收一个配置对象,其中可以设置以下属性:

  • title:string,默认为 "Sorry",设置道歉信息的标题。
  • message:string,默认为 "We are sorry for the inconvenience.",设置道歉信息的副标题,即道歉的具体原因或解释。
  • template:string,默认为 ./node_modules/apology-middleware/template.html,设置道歉页面的模板文件。
  • templateData:object,默认为空对象 {},设置道歉页面的数据。如果需要在道歉页面中使用自定义数据,可以在此处进行配置。可用的变量参见下面的 "道歉页面"。

所有以上配置项都是可选的。如果 titlemessage 都不设置,道歉页面将以最简单的形式展示(仅显示 We are sorry for the inconvenience. 语句)。

道歉页面

道歉页面的模板文件支持 HTML 和 EJS 两种格式。默认的模板文件位于 ./node_modules/apology-middleware/template.html,可以根据需要进行修改。

在模板文件中,可用的变量如下:

  • <%= title %>:string,道歉信息的标题。
  • <%= message %>:string,道歉信息具体的原因或解释。
  • <%= customData %>:object,自定义数据,在 apology() 函数的 templateData 属性中配置。

如果要使用 EJS 格式的模板,可以在 apology() 函数中这样进行配置:

总结

apology-middleware 提供了一个较为简便的方式向用户展示道歉信息。通过使用它,我们可以快速响应用户反馈,及时向其传达解释和道歉的信息,从而提高用户体验和信任度。

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

纠错
反馈