numerica
    Preparing search index...

    Function toRelativeTime

    • Converts a date to a human-readable relative time string.

      Parameters

      • date: Date

        The date to convert to relative time

      • options: Options = {}

        Configuration options

        • now

          Reference date for comparison (default: current date/time)

        • lod

          Level of detail, number of time units to show (default: 1)

        • separator

          Separator between time units (default: ", ")

        • abbreviate

          Use short forms like "5h" instead of "5 hours" (default: false)

        • includeSuffix

          Add "ago" or "in" to the result (default: true)

      Returns string

      The relative time as a human-readable string

      // Assuming now is Jan 1, 2024, 12:00 PM
      toRelativeTime(new Date('2024-01-01T10:00')) // "2 hours ago"
      toRelativeTime(new Date('2024-01-03T12:00')) // "in 2 days"
      toRelativeTime(new Date('2024-01-01T11:58')) // "just now"

      // With level of detail = 2
      toRelativeTime(new Date('2023-12-30T10:00'), {lod: 2})
      // "2 days, 2 hours ago"

      // Abbreviated format
      toRelativeTime(new Date('2024-01-03T14:30'), {abbreviate: true})
      // "in 2d"

      // Without suffix
      toRelativeTime(new Date('2024-01-01T10:00'), {includeSuffix: false})
      // "2 hours"