Node Packaged Masterfully

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

    0.0.9 • Public • Published

    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 );
    }

    CLI

    Installation

    To use the module as a general utility, install the module globally

    npm install -g @stdlib/time-days-in-month

    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

    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-2022. The Stdlib Authors.

    Install

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

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    97

    Version

    0.0.9

    License

    Apache-2.0

    Unpacked Size

    30.4 kB

    Total Files

    13

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser