@mindfulness/utils
    Preparing search index...

    Function endOfYear

    • Type Parameters

      • DateType extends Date

        The Date type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like UTCDate.

      • ResultDate extends Date = DateType

        The result Date type, it is the type returned from the context function if it is passed, or inferred from the arguments.

      Parameters

      • date: DateArg<DateType>

        The original date

      • Optionaloptions: EndOfYearOptions<ResultDate>

        The options

      Returns ResultDate

      The end of a year

      endOfYear

      Return the end of a year for the given date. The result will be in the local timezone.

      // The end of a year for 2 September 2014 11:55:00:
      const result = endOfYear(new Date(2014, 8, 2, 11, 55, 0))
      //=> Wed Dec 31 2014 23:59:59.999