@rooks/use-time-ago

A React Hook to get time ago for timestamp millisecond value

Usage no npm install needed!

<script type="module">
  import rooksUseTimeAgo from 'https://cdn.skypack.dev/@rooks/use-time-ago';
</script>

README

@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

About

A React Hook to get time ago for timestamp millisecond value.

Installation

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

Importing the hook

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

Usage

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 (
    <>
      <p>{timeAgo}</p>
      <p>{timeAgo2}</p>
    </>
  );
}

render(<Demo/>)

Arguments

Argument Type Description Default value
input Date Timestamp etc
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

Returned Value

Timeago string is returned.