@neosjs/timer-logger
一个高性能、类型安全的计时器日志记录库,支持浏览器和 Node.js 环境。内部使用高精度时间 API 提供纳秒级精度,gzip 后仅 2.7KB,适合在开发阶段为任务打点、统计耗时。
安装
sh
pnpm add @neosjs/timer-loggersh
npm i @neosjs/timer-loggersh
yarn add @neosjs/timer-logger快速上手
基本用法
使用默认导出的实例,start 开始计时,end 结束并输出日志:
ts
import timerLogger from '@neosjs/timer-logger'
// 启用计时器
timerLogger.setEnabled(true)
// 方式一:保存返回的 timer,调用 end
const timer = timerLogger.start('my-task')
// ... 执行一些操作
timer?.end('任务完成')
// 方式二:使用标签方式
timerLogger.start('another-task')
// ... 执行一些操作
timerLogger.end('another-task', '另一个任务完成')创建自定义实例
ts
import { createTimerLogger } from '@neosjs/timer-logger'
const customLogger = createTimerLogger({
enabled: true
})
customLogger.start('custom-task')
// ... 执行操作
customLogger.end('custom-task', '自定义任务')获取耗时数据
ts
import timerLogger from '@neosjs/timer-logger'
timerLogger.setEnabled(true)
timerLogger.start('task1')
timerLogger.start('task2')
timerLogger.start('task3')
// ... 执行操作
// 获取各个计时器的原始耗时(毫秒)
console.log('task1 时间:', timerLogger.getLabelTime('task1'), 'ms')
console.log('task2 时间:', timerLogger.getLabelTime('task2'), 'ms')
// 获取所有活跃计时器的总时间
const totalTime = timerLogger.getTotalTime()
console.log('总时间:', totalTime, 'ms')API
默认实例(timerLogger)
| 方法 | 说明 |
|---|---|
setEnabled(enabled: boolean) | 启用或禁用计时器 |
isEnabled(): boolean | 检查是否启用 |
start(label?: string): BaseTimerLogger | undefined | 开始计时,返回计时器对象 |
end(label: string, overrideLabel?: string, options?: TimeFormatOptions): void | 结束计时并输出日志 |
get(label: string, options?: TimeFormatOptions): string | undefined | 获取计时结果 |
getLabelTime(label: string): number | undefined | 获取原始毫秒数 |
getTotalTime(): number | 获取所有活跃计时器的总时间 |
clear(label: string): boolean | 清除指定标签的计时器 |
reset(): void | 重置计时器 |
工厂函数
createTimerLogger(options: TimerLoggerOptions):创建独立实例,options.enabled控制是否启用。
相关类型
ts
interface TimerLoggerOptions {
enabled?: boolean
}
type HrTime = readonly [number, number] // [秒, 纳秒]环境支持
- 浏览器:使用
performance.now()API - Node.js:使用
process.hrtime()API - 其他环境:降级使用
Date.now()