@ flatfile/ utils- 调试器
此软件包是一个工具调试器, 旨在方便对应用程序中的各种事件、 问题和进程进行跟踪、 记录和调试 。 它具有色彩丰富的控制台输出功能,以更好地显示和了解您的系统状况.
特征
- HTTP 请求日志
- 事件订阅记录
- 事件记录
- 记录警告、成功和错误
- 通用伐木
使用量
@ flatfile/ utils- debugger 软件包提供了一个 Debugger 它暴露了几种静态方法 每一种方法都旨在记录具体类型的事件或问题.
以下是现有方法的概述:
对数Http 请求( 段落)
关于HTTP请求的日志细节. 它需要具有下列属性的对象:
method: HTTP 方法( GET, POST, PUT, DELETE等)url: 请求 URL.statusCode: HTTP 状态代码.headers:请求头.startTime:请求开始的时间.error(可选) : 请求中发生的任何错误 .
日志包括方法,状态代码,URL,以及请求开始以来所经过的时间.
✓ 100ms GET 200 https://example.com
logEvent 订阅器( 清空, 过滤器)
一个事件订阅者的日志细节 .
query: 用户正在监听的查询或查询数组.filter: 应用到订阅者的过滤器(可选).
↳ on(user.created), {}
日志事件( 事件)
记录特定事件的详情 .
event: 事件对象日志 。 一定是这样topic, (中文(简体) ),createdAt,以及id属性.
▶ user.created 5:58:30.572 PM 4hs98r
日志警告(消息),日志成功(消息),日志Error(消息,标签,前缀)
日志警告、成功和错误.
message: 要日志的信息 .label财务报告和审定财务报表prefix属于logError函数.
⚠️ Disk space running low
✅ File uploaded successfully
🔴 Error:FileError File not found
日志( 回调)
一个通用日志方法,它接受一个将字符串返回日志的回调函数. 调用对象接收一个颜色对象,您可以用来将颜色应用到您信件的部分内容中.
安装
要安装 @ flatfile/ utils- debugger 包, 请使用 npm 或纱线 :
npm install @flatfile/utils-debugger
或者说
yarn add @flatfile/utils-debugger
依赖关系
此套件对调色控制台输出的ansi-colors套件有依赖性.
实例
import { Debugger } from '@flatfile/utils-debugger'
Debugger.logHttpRequest({
method: 'GET',
url: 'https://example.com',
statusCode: 200,
headers: {},
startTime: Date.now(),
})
Debugger.logEventSubscriber('user.created')
Debugger.logEvent({
topic: 'user.created',
createdAt: new Date(),
id: 'abcd1234',
})
Debugger.logWarning('Disk space running low')
Debugger.logSuccess('File uploaded successfully')
Debugger.logError('File not found', 'FileError', 'Upload')