Time utilities.
npm install @stdlib/timeWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Time utilities.
``bash`
npm install @stdlib/time
`javascript`
var time = require( '@stdlib/time' );
#### time
Namespace containing time utilities.
`javascript`
var ns = time;
// returns {...}
- [dayOfQuarter( [month[, day, year]] )][@stdlib/time/day-of-quarter]: determine the day of the quarter.
- [dayOfYear( [month[, day, year]] )][@stdlib/time/day-of-year]: determine the day of the year.
- [daysInMonth( [month[, year]] )][@stdlib/time/days-in-month]: determine the number of days in a month.
- [daysInYear( [value] )][@stdlib/time/days-in-year]: determine the number of days in a year according to the Gregorian calendar.
- [hoursInMonth( [month[, year]] )][@stdlib/time/hours-in-month]: determine the number of hours in a month.
- [hoursInYear( [value] )][@stdlib/time/hours-in-year]: determine the number of hours in a year according to the Gregorian calendar.
- [isoWeeksInYear( [value] )][@stdlib/time/iso-weeks-in-year]: determine the number of ISO weeks in a year according to the Gregorian calendar.
- [minutesInMonth( [month[, year]] )][@stdlib/time/minutes-in-month]: determine the number of minutes in a month.
- [minutesInYear( [value] )][@stdlib/time/minutes-in-year]: determine the number of minutes in a year according to the Gregorian calendar.
- [quarterOfYear( [month] )][@stdlib/time/quarter-of-year]: determine the quarter of the year.
- [secondsInMonth( [month[, year]] )][@stdlib/time/seconds-in-month]: determine the number of seconds in a month.
- [secondsInYear( [value] )][@stdlib/time/seconds-in-year]: determine the number of seconds in a year according to the Gregorian calendar.
`javascript
var num = time.daysInYear( 2000 );
// returns 366
num = time.hoursInMonth( 2, 2017 );
// returns 672
`
- [tic()][@stdlib/time/tic]: return a high-resolution time.
- [toc( time )][@stdlib/time/toc]: return a high-resolution time difference.
`javascript
var time = require( '@stdlib/time' );
var start = time.tic();
setTimeout( onTimeout, 2000 );
function onTimeout() {
var elapsed = time.toc( start );
console.log( 'Elapsed: %d seconds and %d nanoseconds', elapsed[0], elapsed[1] );
}
`
`javascript
var objectKeys = require( '@stdlib/utils/keys' );
var time = require( '@stdlib/time' );
console.log( objectKeys( time ) );
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/time.svg
[npm-url]: https://npmjs.org/package/@stdlib/time
[test-image]: https://github.com/stdlib-js/time/actions/workflows/test.yml/badge.svg?branch=v0.3.3
[test-url]: https://github.com/stdlib-js/time/actions/workflows/test.yml?query=branch:v0.3.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/time/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/time?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
[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/tree/deno
[deno-readme]: https://github.com/stdlib-js/time/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/time/tree/umd
[umd-readme]: https://github.com/stdlib-js/time/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/time/tree/esm
[esm-readme]: https://github.com/stdlib-js/time/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/time/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/time/main/LICENSE
[@stdlib/time/tic]: https://github.com/stdlib-js/time/tree/main/tic
[@stdlib/time/toc]: https://github.com/stdlib-js/time/tree/main/toc
[@stdlib/time/day-of-quarter]: https://github.com/stdlib-js/time/tree/main/day-of-quarter
[@stdlib/time/day-of-year]: https://github.com/stdlib-js/time/tree/main/day-of-year
[@stdlib/time/days-in-month]: https://github.com/stdlib-js/time/tree/main/days-in-month
[@stdlib/time/days-in-year]: https://github.com/stdlib-js/time/tree/main/days-in-year
[@stdlib/time/hours-in-month]: https://github.com/stdlib-js/time/tree/main/hours-in-month
[@stdlib/time/hours-in-year]: https://github.com/stdlib-js/time/tree/main/hours-in-year
[@stdlib/time/iso-weeks-in-year]: https://github.com/stdlib-js/time/tree/main/iso-weeks-in-year
[@stdlib/time/minutes-in-month]: https://github.com/stdlib-js/time/tree/main/minutes-in-month
[@stdlib/time/minutes-in-year]: https://github.com/stdlib-js/time/tree/main/minutes-in-year
[@stdlib/time/quarter-of-year]: https://github.com/stdlib-js/time/tree/main/quarter-of-year
[@stdlib/time/seconds-in-month]: https://github.com/stdlib-js/time/tree/main/seconds-in-month
[@stdlib/time/seconds-in-year]: https://github.com/stdlib-js/time/tree/main/seconds-in-year