NPM 包 "WhatHappened" 使用教程

阅读时长 3 分钟读完

介绍

在前端开发中,我们常常需要监控代码中的报错和异常情况,方便我们快速定位问题和进行修复。"WhatHappened" 是一个简单易用的错误监控工具,提供实时监控和报警功能。该工具通过将监控信息发送到 Github Issue 中来实现,没有任何服务器成本。

安装

"whatHappened" 可以通过 NPM 安装,执行以下命令即可:

使用

初始化

首先,我们需要在代码中调用 whathappened 的 init() 方法进行初始化,示例代码如下:

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

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

以上代码中,我们传入了以下参数:

  • authToken:Github personal access token,用于授权 whathappened 访问 Github API。
  • repo:Github 仓库名称。
  • owner:Github 仓库的所有者名称。
  • errorHandler:可选参数,当 whathappened 发生错误时的错误处理函数。

手动手动上报错误信息

除了自动监测错误外,我们也可以手动上报错误信息,示例代码如下:

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

以上代码中,我们可以传入以下参数:

  • title:Github issue 标题。
  • body:Github issue 正文。
  • extra:可选参数,用于传递更多信息。

配置

whathappened 也提供了一些可选配置项,例如:

-- -------------------- ---- -------
-------------------
   ---------- -------------------------
   ----- ------------
   ------ ------------------
   ------------- ----- -- -
      ------------------
   --
   -------------- ---------- ----------
   ------------------ -----
   -------------------- ----
--
  • excludeErrors:可选参数,用于指定一些错误类型不上报。
  • reportGeolocation:可选参数,是否在 report 错误时上报用户地理位置信息。
  • reportConsoleErrors:可选参数,是否上报 console 中的错误信息。

总结

"whathappened" 作为一个简单易用的错误监控工具,可以方便我们在开发过程中监控代码中的报错和异常情况,提供更好的开发体验。使用该工具,我们可以通过 Github Issue 实现错误上报,有效减少服务器成本。希望本篇文章对大家有所帮助。

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

纠错
反馈