timediff

README

timediff

timediff is a Go package for printing human readable, relative time differences. Output is based on ranges defined in the Day.js JavaScript library, and can be customized if needed. It's currently used by the mergestat command-line interface.

go get github.com/mergestat/timediff

import (
    "github.com/mergestat/timediff"
)

str1 := timediff.TimeDiff(time.Now().Add(-10 * time.Second))
fmt.Println(str1) // a few seconds ago

str2 := timediff.TimeDiff(time.Now().Add(-3 * time.Minute))
fmt.Println(str2) // 3 minutes ago

str3 := timediff.TimeDiff(time.Now().Add(-23 * time.Hour))
fmt.Println(str3) // a day ago

str4 := timediff.TimeDiff(time.Now().Add(23 * time.Hour))
fmt.Println(str4) // in a day

str5 := timediff.TimeDiff(time.Now().Add(10 * time.Hour))
fmt.Println(str5) // in 10 hours

str := timediff.TimeDiff(time.Now().Add(-3 * time.Minute), timediff.WithLocale("pt-BR"))
fmt.Println(str) // em 3 minutos

Here are examples of durations and their corresponding string outputs (taken from test output), using default options:

-864000h   100 years ago
-172800h   20 years ago
-17280h    2 years ago
-8640h     a year ago
-7200h1m   a year ago
-7200h     10 months ago
-6480h     9 months ago
-1920h     3 months ago
-1104h     2 months ago
-1080h     a month ago
-624h      a month ago
-600h      25 days ago
-240h      10 days ago
-36h       2 days ago
-24h       a day ago
-22h       a day ago
-21h30m    a day ago
-21h       21 hours ago
-20h       20 hours ago
-2h        2 hours ago
-90m       2 hours ago
-89m       an hour ago
-80m       an hour ago
-1h        an hour ago
-60m       an hour ago
-45m       an hour ago
-44m       44 minutes ago
-10m       10 minutes ago
-2m        2 minutes ago
-90s       2 minutes ago
-89s       a minute ago
-45s       a minute ago
-44s       a few seconds ago
-10s       a few seconds ago
10s        in a few seconds
44s        in a few seconds
45s        in a minute
89s        in a minute
90s        in 2 minutes
2m         in 2 minutes
10m        in 10 minutes
44m        in 44 minutes
45m        in an hour
60m        in an hour
1h         in an hour
80m        in an hour
89m        in an hour
90m        in 2 hours
2h         in 2 hours
20h        in 20 hours
21h        in 21 hours
21h30m     in a day
22h        in a day
24h        in a day
36h        in 2 days
240h       in 10 days
600h       in 25 days
624h       in a month
1080h      in a month
1104h      in 2 months
1920h      in 3 months
6480h      in 9 months
7200h      in 10 months
7200h1m    in a year
8640h      in a year
17280h     in 2 years
172800h    in 20 years
864000h    in 100 years

Documentation

Index

• func TimeDiff(t time.Time, options ...TimeDiffOption) string
• type TimeDiffOption
  • func WithCustomFormatters(f locale.Formatters) TimeDiffOption
  • func WithLocale(locale locale.Locale) TimeDiffOption
  • func WithStartTime(t time.Time) TimeDiffOption

Functions

func TimeDiff

func TimeDiff(t time.Time, options ...TimeDiffOption) string

TimeDiff prints a human-readable string representing the difference between two `time.Time`s. By default, the "start" time is time.Now(), but can be overridden with the WithStartTime(t time.Time) option.

Types

type TimeDiffOption

type TimeDiffOption func(*timeDiffOptions)

TimeDiffOption is an option used to customize a call to TimeDiff

func WithCustomFormatters

func WithCustomFormatters(f locale.Formatters) TimeDiffOption

WithCustomFormatters overrides the formatters supplied by any registered and used locale

func WithLocale

func WithLocale(locale locale.Locale) TimeDiffOption

WithLocale changes the locale used for the diff operation

func WithStartTime

func WithStartTime(t time.Time) TimeDiffOption

WithStartTime changes the start time from which time diff calculations are made. Defaults to time.Now().