npm 包 time-away 使用教程

介绍

npm 包 time-away 是一个 JavaScript 库，用于计算给定时间与现在时间之间的时间差距。

在 Web 开发中，经常需要计算时间差来展示时间戳、计时器等功能。time-away 可以为我们提供方便快捷的值，让我们更加专注于逻辑代码的开发。

安装

你可以通过 npm 来安装 time-away：

npm install time-away

使用

基本用法

time-away 提供了两个函数：ago() 和 timeDiff()。

ago() 用于计算给定时间与现在时间之间的相对时间：

import { ago } from 'time-away';

ago('2021-01-01T00:00:00.000Z') // => "8 months ago"

timeDiff() 用于计算给定时间与现在时间之间的时间差距:

import { timeDiff } from 'time-away';

timeDiff('2021-01-01T00:00:00.000Z') // => 2102400000

timeDiff() 返回的是毫秒数，可以用于进一步的处理。

如果给定的时间是一个字符串，time-away 会自动尝试将其转换为 Date 对象。你也可以直接传入一个 Date 对象。

选项

time-away 还提供了一系列选项，可用于格式化输出。

覆盖默认

如果您想使用不同于默认值的文本，您可以通过 fullName 选项覆盖它：

import { ago, timeDiff } from 'time-away';

ago('2021-01-01T00:00:00.000Z', { fullName: true }) // => "8 months ago"
timeDiff('2021-01-01T00:00:00.000Z', { fullText: true }) // => "25 days 22 hours 24 minutes 57 seconds ago"

长格式时间差

您可以通过 longForm 选项将 longForm 值设置为 true，从而更改 timeDiff 函数返回的时间间隔格式

import { timeDiff } from 'time-away';

timeDiff('2021-01-01T00:00:00.000Z', { longForm: true }) // => { days: 25, hours: 22, minutes: 24, seconds: 57, milliseconds: 885 }

忽略区域设置

如果您想忽略时间差的区域设置，可以将 useNative 不为 true。

import { timeDiff } from 'time-away';

timeDiff('2021-01-01T00:00:00.000Z', { useNative: false }) // => "25 days 22 hours 24 minutes 57 seconds ago"

但需要注意的是，这种方法可能会导致时间差距的输出格式有所不同。

示例代码

import { ago } from 'time-away';

console.log(ago('2021-01-01T00:00:00.000Z', { fullName: true })); // => "8 months ago"

import { timeDiff } from 'time-away';

console.log(timeDiff('2021-01-01T00:00:00.000Z', { longForm: true })); // => { days: 25, hours: 22, minutes: 24, seconds: 57, milliseconds: 885 }

总结

time-away 是一款轻量级的 JavaScript 库，可用于计算给定时间与现在时间之间的时间差差距。它提供了多种选项以便于您格式化时间差展示。它可以用于各种场合，如计时器显示，时间日期显示等等。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055aa781e8991b448d827f