@mindfulness/utils
    Preparing search index...

    Function setWeek

    • 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

      • week: number

        The week of the new date

      • Optionaloptions: SetWeekOptions<ResultDate>

        An object with options

      Returns ResultDate

      The new date with the local week set

      setWeek

      Set the local week to the given date, saving the weekday number. The exact calculation depends on the values of options.weekStartsOn (which is the index of the first day of the week) and options.firstWeekContainsDate (which is the day of January, which is always in the first week of the week-numbering year)

      Week numbering: https://en.wikipedia.org/wiki/Week#The_ISO_week_date_system

      // Set the 1st week to 2 January 2005 with default options:
      const result = setWeek(new Date(2005, 0, 2), 1)
      //=> Sun Dec 26 2004 00:00:00

      // Set the 1st week to 2 January 2005,
      // if Monday is the first day of the week,
      // and the first week of the year always contains 4 January:
      const result = setWeek(new Date(2005, 0, 2), 1, {
        weekStartsOn: 1,
        firstWeekContainsDate: 4
      })
      //=> Sun Jan 4 2004 00:00:00

    Settings

    Member Visibility