moment-weekday-calc

v1.1.5

Weekdays calculator: calculates number of days from the given set within the given diff. For example: calculate quantity of business days in 2015 financial year starting on 1 Apr 2015 For more information about how to use this package see README

Latest version published 7 months ago

License: MIT

NPM

GitHub

Package Health Score

58 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.1.5	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.4	\|	01/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.6	\|	09/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,063)

GitHub Stars: 85
Forks: 13
Contributors: 5

Direct Usage Popularity

The npm package moment-weekday-calc receives a total of 1,063 downloads a week. As such, we scored moment-weekday-calc popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package moment-weekday-calc, we found that it has been starred 85 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like moment-weekday-calc is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 10
Open PR: 0
Last Release: 7 months ago
Last Commit: 7 months ago

Further analysis of the maintenance status of moment-weekday-calc based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that moment-weekday-calc demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 9 years
Dependencies: 0 Direct
Versions: 15
Install Size: 57.8 kB
Dist-tags: 1
# of Files: 17
Maintainers: 1
TS Typings: No

moment-weekday-calc has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Moment Weekday Calculator plugin

This plugin will count specific weekdays in the range, calculate how many calendar days in given amount workdays/business days and when is it N working days from now

Usage

Count all weekdays in the range:

moment().weekdayCalc('1 Apr 2015','31 Mar 2016',[0,1,2,3,4,5,6]); //366, here Sunday is 0  
moment().isoWeekdayCalc('1 Apr 2015','31 Mar 2016',[1,2,3,4,5,6,7]); //366, here Sunday is 7

please notice that weekdays in the array must be integers, NOT strings like '1', '2'

Count all Monday to Friday workdays of 2015-2016 financial year:

moment().weekdayCalc('1 Apr 2015','31 Mar 2016',[1,2,3,4,5]); //262  
moment().isoWeekdayCalc('1 Apr 2015','31 Mar 2016',[1,2,3,4,5]); //262

Count all Monday to Friday workdays except particular holidays:

moment().weekdayCalc('1 Apr 2015','31 Mar 2016',[1,2,3,4,5],['6 Apr 2015','7 Apr 2015'],['10 Apr 2015']); //260  
moment().isoWeekdayCalc('1 Apr 2015','31 Mar 2016',[1,2,3,4,5],['6 Apr 2015','7 Apr 2015'],['10 Apr 2015']); //260  
moment().weekdayCalc({  
  rangeStart: '1 Apr 2015',  
  rangeEnd: '31 Mar 2016',  
  weekdays: [1,2,3,4,5],  
  exclusions: ['6 Apr 2015','7 Apr 2015'],
  inclusions: ['10 Apr 2015']
}) //260

moment().isoWeekdayCalc({  
  rangeStart: '1 Apr 2015',  
  rangeEnd: '31 Mar 2016',  
  weekdays: [1,2,3,4,5],  
  exclusions: ['6 Apr 2015','7 Apr 2015'],
  inclusions: ['10 Apr 2015']
}) //260

moment().weekdayCalc({  
  rangeStart: '1 Apr 2015',  
  rangeEnd: '31 Mar 2016',  
  weekdays: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],  
  exclusions: ['6 Apr 2015','7 Apr 2015'],
  inclusions: ['10 Apr 2015']
}) //260 //It works, however it is recommended to use numerical weekdays

Count all Mondays and Tuesdays of 2015 calendar year:

moment('2015').weekdayCalc([1,2]); //104  
moment('2015').isoWeekdayCalc([1,2]); //104

Count all Fridays in the range:

moment('14 Feb 2014').weekdayCalc('23 Feb 2014',[5]); //2  
moment('14 Feb 2014').isoWeekdayCalc('23 Feb 2014',[5]); //2

It is also possible to subtract days with all "add" functions by passing a negative value.

Calculate when is it 5 business days from now:

moment().addWorkdays(5); //Will find a date within 5 business days from now

Calculate when is it 10 business days from 19 Aug 2015, excluding Aug 26:

moment('2015-08-19').addWorkdays(10, ['2015-08-26']); //2015-09-03

How many calendar days within 5 business days from 19 Aug:

moment('2015-08-19').workdaysToCalendarDays(5); //7

How many calendar days within 10 business days from 19 Aug excluding Aug 26:

moment('2015-08-19').workdaysToCalendarDays(10, ['2015-08-26']); //15

Add 5 working days to Feb 2 if Sunday is working day:

moment('2015-02-02').addWeekdaysFromSet(5, [0,1,2,3,4,5]); //2015-02-08  
moment('2015-02-02').isoAddWeekdaysFromSet(5, [1,2,3,4,5,7]); //2015-02-08 iso format, sunday is 7  
moment('2015-02-02').isoAddWeekdaysFromSet(-5, [1,2,3,4,5,7]) //2015-01-27

Add 5 working days to May 4 excluding May 9 if Saturday is working day:

moment('2015-05-04').isoAddWeekdaysFromSet(5, [1,2,3,4,5,6], ['2015-05-09']); //2015-05-11  
moment('2015-05-04').isoAddWeekdaysFromSet({  
  'workdays': 5,  
  'weekdays': [1,2,3,4,5,6],  
  'exclusions': ['2015-05-09']
}); //2015-05-11

How many calendar days within 11 days from set of We,Th,Fr,Sa,Su from Oct 05:

moment('2015-10-05').weekdaysFromSetToCalendarDays(11,[0,3,4,5,6]) //16  
moment('2015-10-05').isoWeekdaysFromSetToCalendarDays(11,[3,4,5,6,7]) //16 iso format, sunday is 7  
expect(moment('2015-10-05').isoWeekdaysFromSetToCalendarDays({  
  'workdays': 11,  
  'weekdays': [3,4,5,6,7]  
}); //16
// Subtract days:  
expect(moment('2015-10-05').isoWeekdaysFromSetToCalendarDays(-11,[3,4,5,6,7])).to.equal(-15);

How many calendar days within 11 days from set of We,Th,Fr,Sa,Su, excluding Oct 15 from Oct 05:

moment('2015-10-05').weekdaysFromSetToCalendarDays(11, [0,3,4,5,6], ['2015-10-15']) //17  
moment('2015-10-05').isoWeekdaysFromSetToCalendarDays(11, [3,4,5,6,7], ['2015-10-15']) //17 iso format, sunday is 7  
expect(moment('2015-10-05').isoWeekdaysFromSetToCalendarDays({  
  'workdays': 11,  
  'weekdays': [3,4,5,6,7],  
  'exclusions': ['2015-10-15']  
}); //17

Node.js usage:

moment = require('moment');     //please note that you should include moment library first
require('moment-weekday-calc');
console.log(moment().isoWeekdayCalc([2015,0,1],[2015,11,31],[1,2,3,4,5,6,7]));

Installation

NPM

npm install moment-weekday-calc

##Bower bower install moment-weekday-calc

Syntax

weekdayCalc

iso weekdays weekdayCalc

Calculate specified weekdays for dates range excluding particular dates:

moment().isoWeekdayCalc(rangeStart moment|Date|String, rangeEnd moment|Date|String, weekdays Array, exclusions Array, inclusions Array);

Calculate specified weekdays for dates range:

moment().isoWeekdayCalc(rangeStart moment|Date|String, rangeEnd moment|Date|String, weekdays Array);

Calculate specified weekdays for dates range:

moment(rangeStart moment|Date|String).weekdayCalc(rangeEnd moment|Date|String, weekdays Array);

Calculate specified weekdays for the whole current calendar year:

moment().isoWeekdayCalc(weekdays Array);

Calculate specified weekdays for dates range excluding particular dates (object config):

moment().isoWeekdayCalc({
  rangeStart: moment|Date|String, //optional  
  rangeEnd: moment|Date|String, //required  
  weekdays: weekdays Array, //required  
  exclusions: exclusions Array, //optional
  inclusions: inclusions Array //optional
});

rangeStart - the range start

rangeEnd - the range end

weekdays - array of iso weekdays as integers to count [1, 2, 3, 4, 5, 6, 7], 1 is always Monday 7 is always Sunday

exclusions - array of dates to exclude, any moment() acceptable date

inclusions - array of dates to include, overrides weekdays and exclusions, any moment() acceptable date

locale aware weekdayCalc

Calculate specified weekdays for dates range excluding particular dates:

moment().weekdayCalc(rangeStart moment|Date|String, rangeEnd moment|Date|String, weekdays Array, exclusions Array, inclusions Array);

Calculate specified weekdays for dates range:

moment().weekdayCalc(rangeStart moment|Date|String, rangeEnd moment|Date|String, weekdays Array);

Calculate specified weekdays for dates range:

moment(rangeStart moment|Date|String).weekdayCalc(rangeEnd moment|Date|String, weekdays Array);

Calculate specified weekdays for the whole current calendar year:

moment().weekdayCalc(weekdays Array);

Calculate specified weekdays for dates range excluding particular dates (object config):

moment().weekdayCalc({
  rangeStart: moment|Date|String, //optional  
  rangeEnd: moment|Date|String, //required  
  weekdays: weekdays Array, //required  
  exclusions: exclusions Array, //optional
  inclusions: inclusions Array //optional
});

rangeStart - the range start

rangeEnd - the range end

weekdays - array of locale aware weekday numbers as integers or locale weekday strings, for example [1, 2, 3] please notice that range is or 0-6 depending where 0 is Sunday

exclusions - array of dates to exclude, any moment() acceptable date

inclusions - array of dates to include, overrides weekdays and exclusions, any moment() acceptable date

Please be aware that you may receive unexpected results if you use weekdays not matching your locale, for example, if your locale weekdays range is 0-6:

moment().weekdayCalc('1 Jan 2015','31 Dec 2015',[1,2,3,4,5,6,7]); // will throw new WeekDayCalcException("The weekday is out of 0 to 6 range")

Please visit https://momentjs.com/docs/#/get-set/weekday/ for MomentJS reference.

DaysSetConverter (WorkDays converter)

Get a date of workdaysToAdd from dateStart:

moment(dateStart moment|Date|String).addWorkdays(workdaysToAdd int)

Get a date of workdaysToAdd from dateStart excluding dates from exclusions array (except dates from inclusions array):

moment(dateStart moment|Date|String).addWorkdays(workdaysToAdd int, exclusions Array, inclusions Array)

Convert working/business days into calendar days:

moment(dateStart moment|Date|String).workdaysToCalendarDays(workdaysToAdd int)  
moment(dateStart moment|Date|String).workdaysToCalendarDays(workdaysToAdd int, exclusions Array, inclusions Array)

Get a date of workdaysToAdd from dateStart, here workdays are any weekdays from weekdays array:

moment(dateStart moment|Date|String).addWeekdaysFromSet(workdaysToAdd int, weekdays Array)  
moment(dateStart moment|Date|String).addWeekdaysFromSet(workdaysToAdd int, weekdays Array, exclusions Array)  
moment(dateStart moment|Date|String).addWeekdaysFromSet({  
  'workdays': int, //required, it is also possible to use 'days' alias  
  'weekdays': weekdays Array, //optional  
  'exclusions': exclusions Array, //optional  
  'inclusions': inclusions Array //optional  
});

The same as above but with weekdays in iso format:

moment(dateStart moment|Date|String).isoAddWeekdaysFromSet(workdaysToAdd int, weekdays Array)  
moment(dateStart moment|Date|String).isoAddWeekdaysFromSet(workdaysToAdd int, weekdays Array, exclusions Array, inclusions Array)  
moment(dateStart moment|Date|String).isoAddWeekdaysFromSet({  
  'workdays': int, //required, it is also possible to use 'days' alias  
  'weekdays': weekdays Array, //optional  
  'exclusions': exclusions Array, //optional  
  'inclusions': inclusions Array //optional  
})

Convert working/business days into calendar days, here workdays are any weekdays from weekdays array:

moment(dateStart moment|Date|String).weekdaysFromSetToCalendarDays(workdaysToAdd int, weekdays Array)  
moment(dateStart moment|Date|String).weekdaysFromSetToCalendarDays(workdaysToAdd int, weekdays Array, exclusions Array, inclusions Array)  
moment(dateStart moment|Date|String).weekdaysFromSetToCalendarDays({  
  'workdays': int, //required, it is also possible to use 'days' alias  
  'weekdays': weekdays Array, //optional  
  'exclusions': exclusions Array, //optional  
  'inclusions': inclusions Array //optional  
})

The same as above but with weekdays in iso format:

moment(dateStart moment|Date|String).isoWeekdaysFromSetToCalendarDays(workdaysToAdd int, weekdays Array)  
moment(dateStart moment|Date|String).isoWeekdaysFromSetToCalendarDays(workdaysToAdd int, weekdays Array, exclusions Array, inclusions Array)  
moment(dateStart moment|Date|String).isoWeekdaysFromSetToCalendarDays({  
  'workdays': int, //required, it is also possible to use 'days' alias  
  'weekdays': weekdays Array, //optional  
  'exclusions': exclusions Array, //optional  
  'inclusions': inclusions Array //optional  
})

Get an array of dates:

moment().dateRangeToDates({
  rangeStart: [2017,10,2],
  rangeEnd: [2018,1,21],
  weekdays: [1,2,3,4,5]
})

dateStart - the date from which to start weekdays conversion, it is NOW if omitted

weekdays - array of locale aware weekday numbers range of 0-6 or 1-7 for iso prefixed functions

exclusions - array of dates to exclude, any moment() acceptable date

inclusions - array of dates to include, overrides weekdays and exclusions, any moment() acceptable date

moment-weekday-calc development dependencies

chai grunt grunt-cli grunt-contrib-uglify grunt-contrib-watch grunt-mocha-test mocha moment

FAQs

What is moment-weekday-calc?

Weekdays calculator: calculates number of days from the given set within the given diff. For example: calculate quantit... Visit Snyk Advisor to see a full health score report for moment-weekday-calc, including popularity, security, maintenance & community analysis.

Is moment-weekday-calc popular?

The npm package moment-weekday-calc receives a total of 1,063 weekly downloads. As such, moment-weekday-calc popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is moment-weekday-calc well maintained?

We found indications that moment-weekday-calc is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is moment-weekday-calc safe to use?

The npm package moment-weekday-calc was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 13 November-2024, at 04:53 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,063)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Moment Weekday Calculator plugin

Usage

Installation

NPM

Syntax

weekdayCalc

iso weekdays weekdayCalc

locale aware weekdayCalc

DaysSetConverter (WorkDays converter)

moment-weekday-calc development dependencies

FAQs

What is moment-weekday-calc?

Is moment-weekday-calc popular?

Is moment-weekday-calc well maintained?

Is moment-weekday-calc safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues