calc-week-number
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

Calculate Week Number

install size Coverage Status NPM Downloads GitHub License

Gets information about the week number of a given date. This information includes the year and month of the week, the week number of the year, and the week number of the month.

Table of Contents

Intro

Week number according to the ISO-8601 standard, weeks starting on Monday and followed by Tuesday, Wednesday, Thursday, Friday, Saturday, and with Sunday as the seventh and final day.

To know which year or month a week belongs to, we have the following rule: 1 week will belong to the year or month containing more days belonging to that year or month than the other year or month. For example: if a week has the first 3 days in March, but the next 4 days are in April, then that week belongs to April.

Install

You can install it by running:

npm install calc-week-number

or using yarn:

yarn add calc-week-number

Usage

import { getWeekNumber, getSunWeekNumber } from 'calc-week-number';

// For the week start with `Monday` (ISO-8601), get information for the week to which 2024/01/01 belongs 
getWeekNumber(new Date(2024, 0, 1)); 
// { "month": 1, "weekOfMonth": 1, "year": 2024, "weekOfYear": 1 }

// For the week start with `Sunday`, get information for the week to which 2024/12/01 belongs  
getSunWeekNumber(new Date(2024, 11, 1)); 
// { "month": 11, "weekOfMonth": 4, "year": 2024, "weekOfYear": 48 }

API

👉 getWeekNumber(date: Date): WeekInfoResult

For the week start with Monday (ISO-8601), return week number info of given date.


👉 getSunWeekNumber(date: Date): WeekInfoResult

For the week start with Sunday, return week number info of given date.

Interface

WeekInfoResult
Type Description
year Number Year of the week
weekOfYear Number Week number of the year
month Number Month of the week
weekOfMonth Number Number of the week in the month

Maintainer

@thaibalong7

Contributing

Please contribute! Look at the issues.

Package Sidebar

Install

npm i calc-week-number

Weekly Downloads

10

Version

2.0.0

License

MIT

Unpacked Size

14 kB

Total Files

16

Last publish

Collaborators

  • thaibalong7