npm 包 stack-utils-node-internals 使用教程

阅读时长 4 分钟读完

简介

在 Node.js 中,当代码抛出异常时,我们可以通过 Error 对象来获取堆栈信息。堆栈信息包含了错误发生的位置以及调用栈中每一层函数的调用信息,这对于定位问题非常有帮助。

但是,在实际应用中,我们可能需要对堆栈信息进行处理和分析,例如过滤掉某些无关的函数或文件,或者将堆栈信息输出到日志中进行跟踪。而 stack-utils-node-internals 就是一个针对 Node.js 内部模块的堆栈信息解析工具包,能够帮助我们更方便地进行堆栈信息处理和分析。

安装

使用

解析堆栈信息

stack-utils-node-internals 提供了 parseStack 方法来解析堆栈信息,该方法接受一个 Error 对象作为参数,并返回一个包含每个堆栈帧的信息的数组。每个堆栈帧的信息包含以下属性:

  • fileName: 文件名
  • lineNumber: 行号
  • columnNumber: 列号
  • functionName: 函数名
  • methodName: 方法名
  • typeName: 类型名

以下是一个使用示例:

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

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

输出如下:

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

可以看到,parseStack 方法返回了一个数组,包含每个堆栈帧的信息。其中第一个堆栈帧代表了 Node.js 内部模块的引导代码。

过滤堆栈信息

stack-utils-node-internals 提供了 filterFrames 方法来过滤堆栈信息,该方法接受一个包含堆栈帧信息的数组和一个回调函数作为参数,并返回一个新的数组,只包含符合条件的堆栈帧信息。

以下是一个使用示例:

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

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

输出如下:

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

可以看到,通过传入一个回调函数,我们可以自定义过滤条件。上述示例中,我们过滤掉了所有位于 internal 目录下的堆栈帧。

输出堆栈信息

stack-utils-node-internals 提供了 formatStack 方法来输出堆栈信息,该方法接受一个包含堆栈帧信息的数组作为参数,并返回一个格式化后的字符串。输出的字符串可以包含每个堆栈帧的文件名、行号、列号等信息,也可以自定义输出的格式。

以下是一个使用示例:

纠错
反馈