函数 getStartOfWeek

  • getStartOfWeek(date, __namedParameters?): Date

  • 获取某日所在星期开始的date

    参数

    • date: Date

      日期

    • 可选__namedParameters: {
          firstDay?:
              | 0
              | 2
              | 1
              | 3
              | 4
              | 5
              | 6;
          weekOffset?: number;
      } = {}
      • 可选firstDay?:
            | 0
            | 2
            | 1
            | 3
            | 4
            | 5
            | 6
      • 可选weekOffset?: number

    返回 Date

    示例

    const getStart = (date: string, options?: Parameters<typeof getStartOfWeek>[1]) => formatDate(getStartOfWeek(new Date(date), options));

    // ----- 当前星期 -----
    // firstDay 为星期一
    getStart('2023/04/19', { firstDay: 1 }); // '2023-04-17 00:00:00'
    // firstDay 为星期日
    getStart('2023/04/19', { firstDay: 0 }); // '2023-04-16 00:00:00'
    // firstDay 为星期三
    getStart('2023/04/16', { firstDay: 3 }); // '2023-04-12 00:00:00'

    // ----- 上个星期 -----
    // firstDay 为星期一
    getStart('2023/04/19', { firstDay: 1, weekOffset: -1 }); // '2023-04-10 00:00:00'
    // firstDay 为星期日
    getStart('2023/04/19', { firstDay: 0, weekOffset: -1 }); // '2023-04-09 00:00:00'

    // ----- 下个星期 -----
    // firstDay 为星期一
    getStart('2023/04/19', { firstDay: 1, weekOffset: 1 }); // '2023-04-24 00:00:00'
    // firstDay 为星期日
    getStart('2023/04/19', { firstDay: 0, weekOffset: 1 }); // '2023-04-23 00:00:00'