# @dbpiper/timer 中文文档

规范地址：https://npmcn.com/package/%40dbpiper/timer/

版本：1\.0\.0-beta\.2
npm 元数据更新时间：2022-04-05T03:18:20.741Z
中文译文更新时间：2026-11-11T17:05:51.370Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dbpiper/timer
原文对照：https://npmcn.com/package/%40dbpiper/timer/?lang=original
项目主页：https://github.com/dbpiper/timer#readme
源码仓库：https://github.com/dbpiper/timer

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：18.8 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2019-04-04T18:21:02.784Z
- 最新版本发布：2019-04-04T21:30:00.815Z
- 近 30 天下载量：13500（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

简单模块可以给您的代码JavaScript或TypeScript代码定时,看运行需要多长时间.

## 安装

```sh
npm install @dbpiper/timer
```

也可以使用：`pnpm add @dbpiper/timer`、`yarn add @dbpiper/timer`、`bun add @dbpiper/timer`

## README

# @ dbpiper/ timer (英语)

[![Build Status](https://travis-ci.com/dbpiper/timer.svg?branch=master)](https://travis-ci.com/dbpiper/timer) [![npm version](http://img.shields.io/npm/v/@dbpiper/timer.svg?style=flat)](https://npmjs.org/package/@dbpiper/timer "View this project on npm") [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

简单模块,可计时您的代码 JavaScript 或 TypeScript 代码,可查看时间 跑不动了.

## 安装指令

```sh
npm install @dbpiper/timer
```

## 用法说明

```ts
import Timer, { FormattedDuration } from '@dbpiper/timer';

// this starts the timer running
const timer = new Timer();

// you may also start the timer like this
// if you wanted to create the timer instance first and then do some
// setup before starting the timer for instance
timer.start();

// do some stuff here

// formattedDuration has the amount of time that passed between
// the creation and stop times
const formattedDuration = timer.stop();

// you can simply convert the result formattedDuration to a string either
// implicitly or explicitly
// for example:
console.log(formattedDuration);
```

## API 密码

### 计时器

用于访问和使用计时器的实际实例对象. 当创建实例时, 计时器会自动启动 .

### 计时器. start ()

另一种更明确的方式 开始计时器。 这是自动的 但是,如果您想要在创建后完成一些任务,则由构建器调用 ,但是在开始测量之前,可以使用此选项.

### 计时器. stop ()

返回类型 : `FormattedDuration`

这停止了计时器, 并返回所经过的时间 格式化定义实例对象 .

* * *

### 格式化期限

时间流逝 是为了方便地用脚本显示 模块的主要目的是衡量脚本运行花费了多少时间. 因此,你会在运行它之前 启动计时器,然后停止它 完成,将结果打印到屏幕或日志文件或信件 对外服务.

### 格式化的时数

返回类型 : `number`

在此期间的小时数表明,由于最大的单位支持 小时,所有更大的都会在这里。 譬如说两天就到了 因为没有"天数"单位 其原因为: 所支持的最大单位是本单元打算用于 计时码.

如果你的代码运行了数天或数周, 这可能是不对的模块 ,而是打算用于按顺序运行的模块 几分钟或几小时.

### 格式化的时间.分钟

返回类型 : `number`

持续时间的分数.

### 格式化的定时.秒

返回类型 : `number`

持续时间的秒数.

### 格式化的Delation.millise秒

返回类型 : `number`

最小的单位 _@ dbpiper/ timer (英语)_ 支持 .

### 格式化的定时.toString ()

将长度转换为可读字符串,通常使用 暗地里是这样的:

```ts
console.log(formattedDuration);
// or this

const durationString = `${formattedDuration}`;
```

它将印刷上述每个通常单位,从 最大的一个是非零。 每个单位将加一个逗号 空间,除了最后一个 将会有"和"代替.

例如:

`30 hours, 31 minutes and 26.4 seconds`

#### 输出中无毫秒

您可以从这个例子中观察到,在 绳子! 这是因为我觉得加入它们无助于服务 本单元的目的,即衡量 代码会运行到日志或脚本上.

这个变化 _以毫秒计_数字 :

`30 hours, 31 minutes, 26 seconds and 400 milliseconds`

大约是40%, 几乎没有有用的信息。 人员 仍然看着类似的东西: `400 milliseconds` 并说,"嗯,这是关于 半秒钟"。 换句话说,把毫秒放出并制作出来 部分秒不仅在日志中较短,实际上更容易 你读吧!

#### 输出中的一些毫秒

你可能会想,"我早些时候注意到 我可以访问毫秒 明确使用格式化的Duration.millises, 为什么你会把它放在那里 如果它没有被使用?" 这个问题的答案很简单: **实值** 使用过,但是 只有在期限特别短的情况下。 具体来说,如果少于 一秒钟.

例如,持续时间为0.4秒或400毫秒 **没有** 为: 打印为 `0.4 seconds`。这是相反的 [上面的问题](https://npmcn.com/package/%40dbpiper/timer/#readme-no-milliseconds-in-output)。 。 。 . 这是,它是 _还有_ 使阅读和理解更加困难。 已经够多了 比较容易理解 `400 milliseconds` 而不是说 `0.4 seconds`仅仅因为 当你到达这么短的时间范围时,思考一下 明确毫秒.

可能不会经常出现,除非时间很短 代码段。 不过,只要注意,在这种情况下,你 **将** 起来 毫秒长. 换句话说,你需要的时候就有了!

## 许可证

[麻省理工学院](https://github.com/dbpiper/timer/blob/master/LICENSE) 版权 © [大卫·皮珀](https://github.com/dbpiper)

## 常见问题

### @dbpiper/timer 是什么？

简单模块可以给您的代码JavaScript或TypeScript代码定时,看运行需要多长时间\.

### 如何安装 @dbpiper/timer？

在项目目录运行 npm install @dbpiper/timer，或使用 pnpm add / yarn add / bun add。

### @dbpiper/timer 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/dbpiper\_\_timer 是否存在。

### @dbpiper/timer 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dbpiper/timer 可以商用吗？

@dbpiper/timer 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dbpiper/timer 的下载量有多少？

根据 npm 官方下载统计，@dbpiper/timer 在 2026/10/12 – 2026/11/10 这 30 天内被下载 13,500 次，日均约 450 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dbpiper/timer 还在维护吗？

最新版本 1\.0\.0-beta\.2 发布于 2019/04/05（7 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/04/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。