@rooks/use-time-ago

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

``
npm install rooks
`

or

`
yarn add rooks
`

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

!TitleCard

!Build Status![](https://img.shields.io/npm/v/@rooks/use-time-ago/latest.svg) ![](https://img.shields.io/npm/l/@rooks/use-time-ago.svg) ![](https://img.shields.io/npm/dt/@rooks/use-time-ago.svg) ![](https://img.shields.io/david/imbhargav5/rooks.svg?path=packages%2Ftime-ago)

About

`
npm install --save @rooks/use-time-ago
`

Importing the hook

`javascript
import useTimeAgo from "@rooks/use-time-ago"
`

Usage

`jsx
function Demo() {
const [date, setDate] = useState(new Date());
const timeAgo = useTimeAgo(date.getTime() - 1000 * 12, {
locale: "zh_CN"
});
const timeAgo2 = useTimeAgo(date.getTime() - 1000 * 12);
return (
<>


{timeAgo}

render()
``

$3

| Argument | Type | Description | Default value |
| -------- | ------ | -------------- | ------------------ |
| input | Date | Timestamp | etc | Any input that time-ago.js supports | undefined |
| options | Object | Options object | { intervalMs:0 } |

#### Options

| Options | Type | Description | Default value |
| ------------ | ------------ | ---------------------------------------------------------------------- | ------------- |
| intervalMs | milliseconds | Duration after which time-ago has to be calculated | 1000 |
| locale | String | Locale in which value is expected | undefined |
| relativeDate | Date | Relative date object with respect to which time-ago is to be calcuated | Current Time |

$3

Timeago string is returned.