@gravity-ui/date-utils

中文文档
2.7.3发布于 2026/11/02MITTypeScriptCommonJS近 30 天下载 7.9万

Gravity UI date helpers

原始使用文档
文档目录9 节
  1. Install
  2. Usage
  3. Settings
  4. License
  5. For AI agents
  6. When to use
  7. When not to use
  8. Common pitfalls
  9. Documentation for AI agents

@gravity-ui/date-utils

Helpers for managing Date and Time.

Install

npm i @gravity-ui/date-utils

Usage

import {dateTimeParse, dateTime} from '@gravity-ui/date-utils';

// Current date: 2021-08-07T12:10:00
// User's time zone: Europe/Istanbul

const FORMAT = 'YYYY-MM-DDTHH:mm:ssZ';

// parse absolute date
dateTimeParse({year: 2021, month: 7, day: 7})?.format(FORMAT); // "2021-08-07T00:00:00+03:00"
dateTimeParse([2021, 7, 7])?.format(FORMAT); // "2021-08-07T00:00:00+03:00"
dateTimeParse('2021-08-07')?.format(FORMAT); // "2021-08-07T00:00:00+03:00"
dateTimeParse(1621708204063)?.format(FORMAT); // "2021-05-22T21:30:04+03:00"
dateTimeParse('')?.format(FORMAT); // undefined
dateTimeParse('incorrect-date')?.format(FORMAT); // undefined

// parse relative date
dateTimeParse('now')?.format(FORMAT); // "2021-08-07T12:10:00+03:00"
dateTimeParse('now-1d')?.format(FORMAT); // "2021-08-06T12:10:00+03:00"
dateTimeParse('now-1d+1M')?.format(FORMAT); // "2021-09-06T12:10:00+03:00"
dateTimeParse('now/d')?.format(FORMAT); // "2021-08-07T00:00:00+03:00"
dateTimeParse('now+1d/d')?.format(FORMAT); // "2021-08-08T00:00:00+03:00"
dateTimeParse('now-1f')?.format(FORMAT); // undefined

// create dateTime
dateTime().format(FORMAT); // "2021-08-07T12:10:00+03:00"
dateTime({input: '2021-08-07'}).format(FORMAT); // "2021-08-07T00:00:00+03:00"
dateTime({input: '2021-08-07', format: 'YYYY-MM-DD'}).format(FORMAT); // "2021-08-07T00:00:00+03:00"
dateTime({timeZone: 'Asia/Tokyo'}).format(FORMAT); // "2021-08-07T18:10:00+09:00
dateTime({input: ''}).format(FORMAT); // "Invalid Date"
dateTime({input: '2021-08', format: 'YYYY-MM-DD'}).format(FORMAT); // "Invalid Date"

Settings

import {settings} from '@gravity-ui/date-utils';

// Locales management
settings.getLocale(); // default locale "en"
settings.loadLocale('de').then(() => {
  settings.setLocale('de');
  settings.getLocale(); // "de"
});

// Customization
settings.updateLocale({weekStart: 0}); // change first day of week

License

Distributed under the MIT License. See LICENSE for details.

For AI agents

Timezone-aware date/time helpers — parsing (including relative expressions like now-1d/d), formatting, and locale management — without any UI, reach for it when you need to compute and format dates reliably across time zones instead of pulling in a full UI calendar.

When to use

  • Parsing absolute or relative date expressions ('now-1d', 'now/d') into a timezone-aware dateTime object.
  • Formatting dates for display in the user's timezone with locale support.
  • Sharing date logic between server (Node) and client (React) code — the package has no React dependency.

When not to use

  • To render a calendar, date picker, or any date UI, use @gravity-ui/date-components — it builds its visuals on top of this package.
  • For lightweight immutable date math and no timezone/relative-expression needs, date-fns or the native Intl/Date APIs may suffice.

Common pitfalls

  • Calling dateTimeParse('') expecting a date — returns undefined, not a dateTime; guard with optional chaining or a null check.
  • Forgetting to load a locale — settings.setLocale('de') only formats localized names (weekdays, months) after settings.loadLocale('de') has resolved.
  • Hallucinated function formatDate / parseDate — the entry points are dateTimeParse (parse) and dateTime(...).format(...) (format).
  • Assuming the user's timezone is applied automatically — pass timeZone explicitly or the system timezone is used.

Documentation for AI agents

Agent-readable documentation for the installed version is located in node_modules/@gravity-ui/date-utils/build/docs/INDEX.md.

版本与发布记录

@gravity-ui/date-utils 共发布 33 个版本,首次发布于 2023/01/18;过去 12 个月发布了 5 个版本。

版本发布日期距今
2.7.3latest2026/11/0214 天前
2.7.22026/09/142 个月前
2.7.12026/06/244 个月前
2.7.02026/02/198 个月前
2.6.12026/02/198 个月前
2.6.02025/09/261.1 年前

其他发布通道:beta → 2.5.0-beta.0。

关于 @gravity-ui/date-utils 的常见问题

@gravity-ui/date-utils 是什么?

Gravity UI date helpers

如何安装 @gravity-ui/date-utils?

在项目目录运行 npm install @gravity-ui/date-utils,或使用 pnpm add / yarn add / bun add。

@gravity-ui/date-utils 支持 TypeScript 吗?

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

@gravity-ui/date-utils 支持 ESM 还是 CommonJS?

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

@gravity-ui/date-utils 可以商用吗?

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

@gravity-ui/date-utils 的下载量有多少?

根据 npm 官方下载统计,@gravity-ui/date-utils 在 2026/10/17 – 2026/11/15 这 30 天内被下载 78,963 次,日均约 2,632 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gravity-ui/date-utils 还在维护吗?

最新版本 2.7.3 发布于 2026/11/02(14 天前);至今共发布 33 个版本,其中过去 12 个月发布了 5 个;首次发布于 2023/01/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。