time-day-of-quarter

Determine the day of the quarter.

APACHE-2.0 License

Downloads
71
Stars
2
Committers
1

dayOfQuarter

Determine the day of the quarter.

Installation

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

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).
  • To use as a general utility for the command line, install the corresponding CLI package globally.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var dayOfQuarter = require( '@stdlib/time-day-of-quarter' );

dayOfQuarter( [month[, day, year]] )

Returns the day of the quarter.

var num = dayOfQuarter();
// returns <number>

By default, the function returns the day of the quarter for the current date (according to local time). To determine the day of the quarter for a particular day, provide month, day, and year arguments.

var num = dayOfQuarter( 12, 31, 2016 );
// returns 92

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

var num = dayOfQuarter( 12, 31, 2016 );
// returns 92

num = dayOfQuarter( 'dec', 31, 2016 );
// returns 92

num = dayOfQuarter( 'december', 31, 2016 );
// returns 92

The function also supports providing a Date object.

var num = dayOfQuarter( new Date() );
// returns <number>

Examples

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

var months;
var day;
var yr;
var q;
var v;
var i;

months = [
    'January',
    'February',
    'March',
    'April',
    'May',
    'June',
    'July',
    'August',
    'September',
    'October',
    'November',
    'December'
];

yr = 2016;
day = 9;

for ( i = 0; i < months.length; i++ ) {
    q = quarterOfYear( months[ i ] );
    v = dayOfQuarter( months[ i ], day, yr );
    console.log( 'In the year %d, %s %d is day number %d of Q%d.', yr, months[ i ], day, v, q );
}

CLI

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/time-day-of-quarter-cli

Usage

Usage: day-of-quarter [options] [<month> <day> <year>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ day-of-quarter
<number>

For a specific date,

$ day-of-quarter 12 31 2016
92

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


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Rankings
Top 16.49% on Npmjs.org
Badges
Extracted from project README
NPM version Build Status Coverage Status Chat
Related Projects