@mindfulness/utils
    Preparing search index...

    Function formatDistanceToNow

    • Parameters

      • date: string | number | Date

        The given date

      • Optionaloptions: FormatDistanceToNowOptions

        The object with options

      Returns string

      The distance in words

      formatDistanceToNow

      false

      Return the distance between the given date and now in words.

      Distance to now Result
      0 ... 30 secs less than a minute
      30 secs ... 1 min 30 secs 1 minute
      1 min 30 secs ... 44 mins 30 secs [2..44] minutes
      44 mins ... 30 secs ... 89 mins 30 secs about 1 hour
      89 mins 30 secs ... 23 hrs 59 mins 30 secs about [2..24] hours
      23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs 1 day
      41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs [2..30] days
      29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs about 1 month
      44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs about 2 months
      59 days 23 hrs 59 mins 30 secs ... 1 yr [2..12] months
      1 yr ... 1 yr 3 months about 1 year
      1 yr 3 months ... 1 yr 9 month s over 1 year
      1 yr 9 months ... 2 yrs almost 2 years
      N yrs ... N yrs 3 months about N years
      N yrs 3 months ... N yrs 9 months over N years
      N yrs 9 months ... N+1 yrs almost N+1 years

      With options.includeSeconds == true:

      Distance to now Result
      0 secs ... 5 secs less than 5 seconds
      5 secs ... 10 secs less than 10 seconds
      10 secs ... 20 secs less than 20 seconds
      20 secs ... 40 secs half a minute
      40 secs ... 60 secs less than a minute
      60 secs ... 90 secs 1 minute

      date must not be Invalid Date

      options.locale must contain formatDistance property

      // If today is 1 January 2015, what is the distance to 2 July 2014?
      const result = formatDistanceToNow(
        new Date(2014, 6, 2)
      )
      //=> '6 months'

      // If now is 1 January 2015 00:00:00,
      // what is the distance to 1 January 2015 00:00:15, including seconds?
      const result = formatDistanceToNow(
        new Date(2015, 0, 1, 0, 0, 15),
        {includeSeconds: true}
      )
      //=> 'less than 20 seconds'

      // If today is 1 January 2015,
      // what is the distance to 1 January 2016, with a suffix?
      const result = formatDistanceToNow(
        new Date(2016, 0, 1),
        {addSuffix: true}
      )
      //=> 'in about 1 year'

      // If today is 1 January 2015,
      // what is the distance to 1 August 2016 in Esperanto?
      const eoLocale = require('date-fns/locale/eo')
      const result = formatDistanceToNow(
        new Date(2016, 7, 1),
        {locale: eoLocale}
      )
      //=> 'pli ol 1 jaro'

    Settings

    Member Visibility