@stdlib/time-days-in-month
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

daysInMonth

NPM version Build Status Coverage Status

Determine the number of days in a month.

Installation

npm install @stdlib/time-days-in-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 );
}

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/time-days-in-month

Homepage

stdlib.io

Weekly Downloads

52

Version

0.2.2

License

Apache-2.0

Unpacked Size

35.4 kB

Total Files

12

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser