@mindfulness/utils
    Preparing search index...

    Function subWeeks

    • 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 date to be changed

      • amount: number

        The amount of weeks to be subtracted.

      • Optionaloptions: SubWeeksOptions<ResultDate>

        An object with options

      Returns ResultDate

      The new date with the weeks subtracted

      subWeeks

      Subtract the specified number of weeks from the given date.

      // Subtract 4 weeks from 1 September 2014:
      const result = subWeeks(new Date(2014, 8, 1), 4)
      //=> Mon Aug 04 2014 00:00:00