# @box/readable-time 中文文档

规范地址：https://npmcn.com/package/%40box/readable-time/

版本：2\.3\.40
npm 元数据更新时间：2026-11-06T03:57:38.065Z
中文译文更新时间：2026-11-08T12:46:52.095Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40box/readable-time
原文对照：https://npmcn.com/package/%40box/readable-time/?lang=original

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

- 包体积（解压后）：52.8 kB，46 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^18\.0\.0，react-dom ^18\.0\.0，react-intl ^6\.4\.2，@box/blueprint-web ^18\.10\.3，@box/blueprint-web-assets ^5\.15\.0
- 首次发布：2026-04-28T23:59:00.948Z
- 最新版本发布：2026-11-06T03:57:37.896Z
- 近 30 天下载量：31466（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：241（近 12 个月 241 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @box/readable-time
```

也可以使用：`pnpm add @box/readable-time`、`yarn add @box/readable-time`、`bun add @box/readable-time`

## README

-   [可读时间](https://npmcn.com/package/%40box/readable-time/#readme-readable-time)
    -   [概览](https://npmcn.com/package/%40box/readable-time/#readme-overview)
        -   [常规](https://npmcn.com/package/%40box/readable-time/#readme-general)
        -   [目的](https://npmcn.com/package/%40box/readable-time/#readme-purpose)
        -   [详细说明](https://npmcn.com/package/%40box/readable-time/#readme-detailed-description)
        -   [使用量](https://npmcn.com/package/%40box/readable-time/#readme-usage)
    -   [运行命令](https://npmcn.com/package/%40box/readable-time/#readme-running-commands)
    -   [可用命令](https://npmcn.com/package/%40box/readable-time/#readme-available-commands)
    -   [所有权](https://npmcn.com/package/%40box/readable-time/#readme-ownership)
    -   [翻译](https://npmcn.com/package/%40box/readable-time/#readme-translations)

# 可读时间

这个库是用 [@ box/ 自定义](https://npmcn.com/package/automation//README.md). 如何执行任务的概况 在生成的库中查找 [运行任务](https://nx.dev/core-features/run-tasks) Nx 文档

## 概览

### 常规

这个 **可读时间** 共享特性出口a `ReadableTime` 反应组件和一个纯 `getReadableTime` 函数 将时间戳格式化为可读字符串. 所有与时间有关的逻辑都包含在 `getReadableTime` 函数,而 `ReadableTime` 组件用途 它可以在UI中显示格式化的时间戳.

**可读时间** 返回/显示相对时间(如"2小时前")或绝对日期(如"Oct 5, 2018") 属性和当前日期.

该构成部分和职能均采用国际化方法 `react-intl` 支持多种语言和语言. 这个 `ReadableTime` 组件获取 `intl` 对象从上下文 `getReadableTime` 函数 作为参数收到.

### 目的

《公约》的主要目的 **可读时间** 共享的特性是以简单的方式格式和显示时间戳 供用户理解. 它可以处理各种情况,例如显示今天、昨天或具体日期的时间,并且可以包括: 如果需要,时间为当天.

### 详细说明

关于该组件的详细描述,请参见: `src/lib/stories/additional-description.md` 文档. 蓝图文件中也有其他资料 时间 [可读 时间页](https://blueprint.dev.box.net/?path=/docs/shared-features_shared-features-readabletime-docs--docs)。 。 。 .

### 使用量

可读时间的质量是,它可以用作组件或函数.

```typescript
import { ReadableTime } from '@box/readable-time';

const App = () => {
    return <ReadableTime timestamp={1742817318888} />;
};
```

```typescript
import { getReadableTime } from '@box/readable-time';
import { createIntl } from 'react-intl';

const intl = createIntl({ locale: 'en' });
const readableTime = getReadableTime({ timestamp: Date.now(), intl });
```

## 运行命令

您的终端应该留在寄存器根目录的位置, 即 `frontend-mono`。允许 Nx 运行 操作针对您的项目,或者必要时多个项目. 不导航到 `packages/group-shared-features/readable-time` 以运行命令.

项目的命令使用 Nx 使用的语法运行 :

```
Syntax: yarn nx <target name> <project name> <option overrides>
                      |              |                |
Example: yarn nx    test         products         --watch
```

## 可用命令

所有使用 Nx 的命令都可以在 `project.json` 文档.

-   `nx storybook readable-time` - 发射UI组件的开发环境.
-   `nx build-storybook readable-time` - 建立静态版本的故事书 与所有的故事.
-   `nx build readable-time` - 使用 `shared-feature-builder` 执行器从 `automation` 软件包.
-   `nx build readable-time --watch` - 以启用 -- watch 旗构建软件包,用于重建 `dist` 内容基于 变动 `src`。 。 。 .
-   `nx lint readable-time` - 运行linter过包文件.
-   `nx test readable-time` - 进行故事书测试(视频/互动)和笑话单元测试,制作报道报告 结束.
-   `nx test-storybook readable-time` - 做故事书测试 您需要首先在单独的终端开始故事本 这工作.
-   `nx test-storybook-local-coverage readable-time` - 进行故事书测试,并在最后制作报道报告. 需要运行的故事书实例.
-   `nx test-storybook-ci readable-time` - 建立故事书,并进行故事书测试,提供覆盖产出。 为CI设计 用途.
-   `nx test-jest readable-time` - 运行滑稽单元测试, 产生代码覆盖结尾.
-   `nx sonar readable-time` - 使用声纳Qube工具对代码进行静态分析,以检测出臭虫和代码的气味. 集成为CI进程的步骤之一.
-   `nx chromatic readable-time` - 上传故事书,供审查 [框色调](https://box.chromatic.com/) ,以及 将UI变化与基线进行直观比较.
-   `nx prepare readable-time` - 在Nx Release安排的软件包发布过程中运行命令.

## 所有权

特性的代码属于莫吉团队. 拥有团队的责任包括对代码质量的控制,提供 \* 修改准则,并就修改问题与其他小组保持一致。 与下列各方磋商将是一种良好做法: 团队,拥有或请求,将负责执行代码修改.

## 翻译

每个地方 `i18n/*.js` 档案由莫吉·詹金斯管道生成和完成。 共享特性构建器复制到 `dist/i18n/` 期间 `build`中的软件包 `i18n.config.js` 下级 `translationDependencies`。 。 。 .

## 常见问题

### 如何安装 @box/readable-time？

在项目目录运行 npm install @box/readable-time，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0）、react-dom（^18\.0\.0）、react-intl（^6\.4\.2）、@box/blueprint-web（^18\.10\.3）、@box/blueprint-web-assets（^5\.15\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @box/readable-time 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @box/readable-time 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @box/readable-time 可以商用吗？

@box/readable-time 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @box/readable-time 的下载量有多少？

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

### @box/readable-time 还在维护吗？

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