@mindfulness/utils
    Preparing search index...

    Function getWeek

    • Parameters

      • date: string | number | Date

        The given date

      • Optionaloptions: GetWeekOptions

        An object with options

      Returns number

      The week

      getWeek

      Get the local week index of the given date. 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

      // Which week of the local week numbering year is 2 January 2005 with default options?
      const result = getWeek(new Date(2005, 0, 2))
      //=> 2

      // Which week of the local week numbering year is 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 = getWeek(new Date(2005, 0, 2), {
        weekStartsOn: 1,
        firstWeekContainsDate: 4
      })
      //=> 53

    Settings

    Member Visibility