3.0 KiB
3.0 KiB
daysInMonth
Determine the number of days in a month.
Usage
var daysInMonth = require( '@stdlib/time/days-in-month' );
daysInMonth( [month[, year]] )
Returns the number of days in a month.
var num = daysInMonth();
// returns <number>
By default, the function returns the number of days in the current month of the current year (according to local time). To determine the number of days for a particular month and year, provide month
and year
arguments.
var num = daysInMonth( 2 );
// returns <number>
num = daysInMonth( 2, 2016 );
// returns 29
num = daysInMonth( 2, 2017 );
// returns 28
A month
may be either a month's integer value, three letter abbreviation, or full name (case insensitive).
var num = daysInMonth( 2, 2016 );
// returns 29
num = daysInMonth( 'feb', 2016 );
// returns 29
num = daysInMonth( 'february', 2016 );
// returns 29
The function also supports providing a Date
object.
var num = daysInMonth( new Date() );
// returns <number>
Notes
- The function's return value is a generalization and does not take into account inaccuracies due to daylight savings conventions, crossing timezones, or other complications with time and dates.
Examples
var daysInMonth = require( '@stdlib/time/days-in-month' );
var v;
var i;
for ( i = 0; i < 2021; i++ ) {
v = daysInMonth( 'feb', i );
console.log( 'In the year %d, February has %d days.', i, v );
}
CLI
Usage
Usage: days-in-month [options] [month] [year]
Options:
-h, --help Print this message.
-V, --version Print the package version.
Examples
$ days-in-month
<number>
For a specific month,
$ days-in-month 2
<number>
For a specific month and year,
$ days-in-month 2 2016
29