moment-working-days

v0.1.8

This is a Moment.js plugin that allows you to calculate working days considering sequence of date(s) - similar to start-stop timer sequence. You can customize the week off days, and also declare custom dates for holidays (eg: public holidays) to exclude t For more information about how to use this package see README

Latest version published 5 years ago

License: ISC

NPM

GitHub

Package Health Score

48 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

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
0.1.8	\|	12/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.1	\|	12/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

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

Limited

Weekly Downloads (73)

GitHub Stars: 7
Forks: 1
Contributors: 1

Direct Usage Popularity

The npm package moment-working-days receives a total of 73 downloads a week. As such, we scored moment-working-days popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package moment-working-days, we found that it has been starred 7 times.

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

Community

Sustainable

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

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 5 years ago
Last Commit: 5 years ago

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

An important project maintenance signal to consider for moment-working-days is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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: 5 years
Dependencies: 1 Direct
Versions: 10
Install Size: 1.07 MB
Dist-tags: 1
# of Files: 38
Maintainers: 1
TS Typings: No

moment-working-days 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

Working days calculator - Distributed date ranges

This is a Moment.js plugin that allows you to calculate working days, considering sequence of date(s). You can customize the week off days, and also declare custom dates for holidays (eg: public holidays) to exclude them from being counted as working day(s)

Installation

npm install --save moment-working-days

Major Applications

Working Days calculator between Date range(s)
TAT (Turn Around Time Calculator)
Number of Fridays (or any other day) between Date range(s)

Configuration

const WorkingDays = require('moment-working-days')

const momentWorkingdays = new WorkingDays({
  includeToday: true, // optional. Default true
  verbose: true, // optional. Default false
  weekOffDays: [0, 6], // optional. Default [0, 6]
  dateFormat: 'DD-MM-YYYY', // optional. Default 'YYYY-MM-DD'
  customHolidays: ['02-12-2019'], // optional
  customWorkingDays: [] // optional: eg ['07-12-2019']
})

// includeToday: Include today in calculations, else today wll be excluded

// weekOffDays: Defines weekoff days. Note that week starts with day 0 (Sunday) to day 6 (Saturday).

// dateFormat: Moment Date Format in which dates will be passed

// customHolidays: Defines custom holidays for bussiness (eg: public holidays). Pass an array of dates in configured dateFormat

Documentation

Documentation is available at moment-working-days Docs.

API

getWorkingDays(array_of_dates) => number

calculates count of working days, considering custom holidays and weekoffs.
supports distributed date ranges, i.e supports multiple date ranges to be considered for calculation
Configure if we should consider today in calculation
Configure Weekoffs
Configure Public / custom holidays
Configure ustom working days
Support moment date formats
Date pairing similiar to Start-Stop timer pairing
If you pass only one date in array, it will calculate till today
If you pass range of dates, it will calculate after making pair of even and odd indices
Supports future dates

Example 1

&gt; momentWorkingdays.getWorkingDays([
  "29-11-2019", "03-12-2019",
  "07-12-2019", "12-12-2019"
])

&gt; Output
30-11-2019 is a Sat
01-12-2019 is a Sun
02-12-2019 is a Custom Holiday
07-12-2019 is a Sat
08-12-2019 is a Sun
Working Days: 6 day(s)

&gt; Returns
6

// Explanation
- First it creates pairs of odd and even indexed dates.
- Then, it calculates days within a pair (eg: pair1: 29-11 and 03-12. pair2: 07-12 and 12-12).
- Then, it calculates overall working days.
- Hence giving support to distributed date ranges

Example 2

&gt; momentWorkingdays.getWorkingDays([
  "29-11-2019", "03-12-2019",
  "07-12-2019"
])

&gt; Output
30-11-2019 is a Sat
01-12-2019 is a Sun
02-12-2019 is a Custom Holiday
07-12-2019 is a Sat
08-12-2019 is a Sun
Working Days: 3 day(s)

&gt; Returns
3

&gt; Explanation
- If number of elements in input array is odd, then it will pair the last date with today
- Eg: pair1: 29-11 and 03-12. pair2: 07-12 and 09-12 (Todays date)
- Hence giving support to distributed date ranges

Example 3: Calculates working days from 29-11 till today

&gt; momentWorkingdays.getWorkingDays([
  "29-11-2019",
])

&gt; Output
30-11-2019 is a Sat
01-12-2019 is a Sun
02-12-2019 is a Custom Holiday
07-12-2019 is a Sat
08-12-2019 is a Sun
Working Days: 6 day(s)

&gt; Returns
6

Example 4: Count all Fridays between 2 dates

&gt; momentWorkingdays.setWeekOffDays([
  0, 1, 2, 3, 4, 6
]).getWorkingDays(["05-12-2019", "12-12-2019"]))

&gt; Output
05-12-2019 is a Thu
07-12-2019 is a Sat
08-12-2019 is a Sun
09-12-2019 is a Mon
10-12-2019 is a Tue
11-12-2019 is a Wed
12-12-2019 is a Thu
Working Days: 1 day(s)

&gt; Returns
1

isWorkingday(date) => boolean

returns if it is a working day, considering custom holidays and weekoffs

Example 1: Custom Holiday

&gt; momentWorkingdays.isWorkingday("02-12-2019") // Monday

&gt; Output
02-12-2019 is a Custom Holiday

&gt; Returns
false

Example 2: WeekOff

&gt; momentWorkingdays.isWorkingday("01-12-2019") // Sunday

&gt; Output
01-12-2019 is a Sun

&gt; Returns
false

Example 3: Weekday

&gt; momentWorkingdays.isWorkingday("06-12-2019") // Friday

&gt; Returns
true

Example 4: Custom working day

&gt; momentWorkingdays.setCustomWorkingDays([
  '08-12-2019'
]).isWorkingday('08-12-2019')) // Sunday

&gt; Returns
true

addWorkingDays(date, noOfDays) => Date string

returns date, after adding noOfDays of working days

Example

&gt; momentWorkingdays.addWorkingDays("06-12-2019", 2) // Friday

&gt; Output
07-12-2019 is a Sat
08-12-2019 is a Sun

&gt; Returns
10-12-2019 // Tuesday

nextWorkingDay(date) => Date string

returns next working date

Example

&gt; momentWorkingdays.nextWorkingDay("06-12-2019") // Friday

&gt; Output
07-12-2019 is a Sat
08-12-2019 is a Sun

&gt; Returns
09-12-2019 // Monday

subtractWorkingDays(date, noOfDays) => Date string

returns date, after subtracting noOfDays of working days

Example

&gt; momentWorkingdays.subtractWorkingDays("09-12-2019", 2) // Monday

&gt; Output
08-12-2019 is a Sun
07-12-2019 is a Sat

&gt; Returns
05-12-2019 // Thursday

prevWorkingDay(date) => Date string

returns previous working day

Example

&gt; momentWorkingdays.prevWorkingDay("09-12-2019") // Monday

&gt; Output
08-12-2019 is a Sun
07-12-2019 is a Sat

&gt; Returns
06-12-2019  // Friday

License

moment-working-days is free software, licensed under the MIT License. See the LICENSE file for more details.

moment-working-days dependencies

moment

moment-working-days development dependencies

jsdoc

FAQs

What is moment-working-days?

This is a Moment.js plugin that allows you to calculate working days considering sequence of date(s) - similar to start... Visit Snyk Advisor to see a full health score report for moment-working-days, including popularity, security, maintenance & community analysis.

Is moment-working-days popular?

The npm package moment-working-days receives a total of 73 weekly downloads. As such, moment-working-days popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is moment-working-days well maintained?

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

Is moment-working-days safe to use?

The npm package moment-working-days 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 7 November-2024, at 04:45 (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 (73)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Working days calculator - Distributed date ranges

Installation

Major Applications

Configuration

Documentation

API

getWorkingDays(array_of_dates) => number

Example 1

Example 2

Example 3: Calculates working days from 29-11 till today

Example 4: Count all Fridays between 2 dates

isWorkingday(date) => boolean

Example 1: Custom Holiday

Example 2: WeekOff

Example 3: Weekday

Example 4: Custom working day

addWorkingDays(date, noOfDays) => Date string

Example

nextWorkingDay(date) => Date string

Example

subtractWorkingDays(date, noOfDays) => Date string

Example

prevWorkingDay(date) => Date string

Example

License

moment-working-days dependencies

moment-working-days development dependencies

FAQs

What is moment-working-days?

Is moment-working-days popular?

Is moment-working-days well maintained?

Is moment-working-days 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