Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/time-minutes-in-month
Determine the number of minutes in a month.
https://github.com/stdlib-js/time-minutes-in-month
calendar date gregorian javascript min mins minutes mon month node node-js nodejs stdlib time util utilities utility utils
Last synced: 3 months ago
JSON representation
Determine the number of minutes in a month.
- Host: GitHub
- URL: https://github.com/stdlib-js/time-minutes-in-month
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T16:53:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T07:47:09.000Z (3 months ago)
- Last Synced: 2024-11-09T19:07:51.117Z (3 months ago)
- Topics: calendar, date, gregorian, javascript, min, mins, minutes, mon, month, node, node-js, nodejs, stdlib, time, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 971 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# minutesInMonth
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Determine the number of minutes in a month.
## Installation
```bash
npm install @stdlib/time-minutes-in-month
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] 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
```javascript
var minutesInMonth = require( '@stdlib/time-minutes-in-month' );
```
#### minutesInMonth( \[month\[, year]] )
Returns the number of minutes in a month.
```javascript
var num = minutesInMonth();
// returns
```
By default, the function returns the number of minutes in the current month of the current year (according to local time). To determine the number of minutes for a particular month and year, provide `month` and `year` arguments.
```javascript
var num = minutesInMonth( 2 );
// returns
num = minutesInMonth( 2, 2016 );
// returns 41760
num = minutesInMonth( 2, 2017 );
// returns 40320
```
A `month` may be either a month's integer value, three letter abbreviation, or full name (case insensitive).
```javascript
var num = minutesInMonth( 2, 2016 );
// returns 41760
num = minutesInMonth( 'feb', 2016 );
// returns 41760
num = minutesInMonth( 'february', 2016 );
// returns 41760
```
The function also supports providing a [`Date`][date-object] object.
```javascript
var num = minutesInMonth( new Date() );
// returns
```
## 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
```javascript
var minutesInMonth = require( '@stdlib/time-minutes-in-month' );
var v;
var i;
for ( i = 0; i < 2021; i++ ) {
v = minutesInMonth( 'feb', i );
console.log( 'In the year %d, February has %d minutes.', i, v );
}
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/time-minutes-in-month-cli
```
### Usage
```text
Usage: minutes-in-month [options] [month] [year]
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
### Examples
```bash
$ minutes-in-month
```
For a specific month,
```bash
$ minutes-in-month 2
```
For a specific month and year,
```bash
$ minutes-in-month 2 2016
41760
```
* * *
## See Also
- [`@stdlib/time-minutes-in-year`][@stdlib/time/minutes-in-year]: determine the number of minutes in a year according to the Gregorian calendar.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/time-minutes-in-month.svg
[npm-url]: https://npmjs.org/package/@stdlib/time-minutes-in-month
[test-image]: https://github.com/stdlib-js/time-minutes-in-month/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/time-minutes-in-month/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/time-minutes-in-month/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/time-minutes-in-month?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/time-minutes-in-month#cli
[cli-url]: https://github.com/stdlib-js/time-minutes-in-month/tree/cli
[@stdlib/time-minutes-in-month]: https://github.com/stdlib-js/time-minutes-in-month/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/time-minutes-in-month/tree/deno
[deno-readme]: https://github.com/stdlib-js/time-minutes-in-month/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/time-minutes-in-month/tree/umd
[umd-readme]: https://github.com/stdlib-js/time-minutes-in-month/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/time-minutes-in-month/tree/esm
[esm-readme]: https://github.com/stdlib-js/time-minutes-in-month/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/time-minutes-in-month/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/time-minutes-in-month/main/LICENSE
[date-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
[@stdlib/time/minutes-in-year]: https://github.com/stdlib-js/time-minutes-in-year