@stdlib/time-quarter-of-year
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    quarterOfYear

    NPM version Build Status Coverage Status dependencies

    Determine the quarter of the year.

    Installation

    npm install @stdlib/time-quarter-of-year

    Usage

    var quarterOfYear = require( '@stdlib/time-quarter-of-year' );

    quarterOfYear( [month] )

    Returns the quarter of the year.

    var q = quarterOfYear();
    // returns <number>

    By default, the function returns the quarter of the year for the current month in the current year (according to local time). To determine the quarter for a particular month, provide either a month or a Date object.

    var q = quarterOfYear( new Date() );
    // returns <number>
    
    q = quarterOfYear( 4 );
    // returns 2

    A month may be either a month's integer value, three letter abbreviation, or full name (case insensitive).

    var q = quarterOfYear( 4 );
    // returns 2
    
    q = quarterOfYear( 'April' );
    // returns 2
    
    q = quarterOfYear( 'apr' );
    // returns 2

    Examples

    var quarterOfYear = require( '@stdlib/time-quarter-of-year' );
    
    var months;
    var q;
    var i;
    
    months = [
        'January',
        'February',
        'March',
        'April',
        'May',
        'June',
        'July',
        'August',
        'September',
        'October',
        'November',
        'December'
    ];
    
    for ( i = 0; i < months.length; i++ ) {
        q = quarterOfYear( months[ i ] );
        console.log( 'The month of %s is in Q%d.', months[ i ], q );
    }

    CLI

    Installation

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

    npm install -g @stdlib/time-quarter-of-year

    Usage

    Usage: quarter-of-year [options] [month]
    
    Options:
    
      -h,    --help                Print this message.
      -V,    --version             Print the package version.
    

    Examples

    $ quarter-of-year
    <number>

    For a specific month,

    $ quarter-of-year 4
    2

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

    Install

    npm i @stdlib/time-quarter-of-year

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    10

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    40.6 kB

    Total Files

    13

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser