npm包blgn使用教程

简介

blgn是一款轻量级、易用的前端日志记录工具。通过它，你可以在前端JavaScript代码中快速完成日志打印、异常捕获等操作。

安装

你可以使用npm来安装blgn：

npm install blgn --save

使用

引入

在使用blgn之前，需要先将它引入到你的项目中。可以使用ES6的import语法：

import BLGN from 'blgn';

也可以直接在HTML中使用script标签引入：

<script src="path/to/blgn.min.js">

初始化

BLGN.config({
    // 配置
});

blgn初始化的时候还有很多的配置，包括：

• debugEnabled: 是否启动debug模式，默认为false
• logLevel: 日志记录的级别，默认为'log'
• consoleLevel: 控制台输出的日志级别，默认为'debug'
• info: 是否显示页面信息（页面地址，viewport，屏幕宽高等），默认为false
• exception: 是否记录捕获的异常，包括window.onerror和未处理的promise rejection，默认为true

日志记录

BLGN.log('这是一条log信息');
BLGN.debug('这是一条debug信息');
BLGN.info('这是一条info信息');
BLGN.warn('这是一条warn信息');
BLGN.error('这是一条error信息');

异常捕获

在使用blgn时，你可以启用异常捕获，记录未处理的异常：

BLGN.config({
    exception: true
});

如果启用了异常捕获，当页面抛出未处理的异常时，blgn会将它记录到日志中：

window.addEventListener('unhandledrejection', function(event) {
    BLGN.error(event);
});

定制

你可以通过在初始化时传入自定义参数来进行定制：

-- -------------------- ---- -------
-------------
    ------------- -----
    --------- -------
    ------------- ------
    ----- -----
    ---------- -----
    -------- --------------- -
        -------------------
    -
---
展开代码

• debugEnable: 是否启用debug模式
• logLevel: 日志级别
• consoleLevel: 控制台输出日志级别
• info: 是否显示页面信息
• exception: 是否记录捕获的异常
• onError: 异常处理方法

示例

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

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

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

-- --------
--------------------- -
    ----- --- ------------------
-- ---
展开代码

总结

blgn是一个轻量级、易用的前端日志记录工具。通过它，我们可以在前端JavaScript代码中快速完成日志打印、异常捕获等操作，有助于我们更好地进行前端开发和排查问题。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/72318