224 lines
8.0 KiB
Markdown
224 lines
8.0 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Time
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
|
||
|
|
|
||
|
|
> Standard library time utilities.
|
||
|
|
|
||
|
|
<section class="installation">
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install @stdlib/time
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var time = require( '@stdlib/time' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### time
|
||
|
|
|
||
|
|
Standard library time utilities.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var ns = time;
|
||
|
|
// returns {...}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Calendar Utilities
|
||
|
|
|
||
|
|
<!-- <toc keywords="+calendar"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`dayOfQuarter( [month[, day, year]] )`][@stdlib/time/day-of-quarter]</span><span class="delimiter">: </span><span class="description">determine the day of the quarter.</span>
|
||
|
|
- <span class="signature">[`dayOfYear( [month[, day, year]] )`][@stdlib/time/day-of-year]</span><span class="delimiter">: </span><span class="description">determine the day of the year.</span>
|
||
|
|
- <span class="signature">[`daysInMonth( [month[, year]] )`][@stdlib/time/days-in-month]</span><span class="delimiter">: </span><span class="description">determine the number of days in a month.</span>
|
||
|
|
- <span class="signature">[`daysInYear( [value] )`][@stdlib/time/days-in-year]</span><span class="delimiter">: </span><span class="description">determine the number of days in a year according to the Gregorian calendar.</span>
|
||
|
|
- <span class="signature">[`hoursInMonth( [month[, year]] )`][@stdlib/time/hours-in-month]</span><span class="delimiter">: </span><span class="description">determine the number of hours in a month.</span>
|
||
|
|
- <span class="signature">[`hoursInYear( [value] )`][@stdlib/time/hours-in-year]</span><span class="delimiter">: </span><span class="description">determine the number of hours in a year according to the Gregorian calendar.</span>
|
||
|
|
- <span class="signature">[`isoWeeksInYear( [value] )`][@stdlib/time/iso-weeks-in-year]</span><span class="delimiter">: </span><span class="description">determine the number of ISO weeks in a year according to the Gregorian calendar.</span>
|
||
|
|
- <span class="signature">[`minutesInMonth( [month[, year]] )`][@stdlib/time/minutes-in-month]</span><span class="delimiter">: </span><span class="description">determine the number of minutes in a month.</span>
|
||
|
|
- <span class="signature">[`minutesInYear( [value] )`][@stdlib/time/minutes-in-year]</span><span class="delimiter">: </span><span class="description">determine the number of minutes in a year according to the Gregorian calendar.</span>
|
||
|
|
- <span class="signature">[`quarterOfYear( [month] )`][@stdlib/time/quarter-of-year]</span><span class="delimiter">: </span><span class="description">determine the quarter of the year.</span>
|
||
|
|
- <span class="signature">[`secondsInMonth( [month[, year]] )`][@stdlib/time/seconds-in-month]</span><span class="delimiter">: </span><span class="description">determine the number of seconds in a month.</span>
|
||
|
|
- <span class="signature">[`secondsInYear( [value] )`][@stdlib/time/seconds-in-year]</span><span class="delimiter">: </span><span class="description">determine the number of seconds in a year according to the Gregorian calendar.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var num = time.daysInYear( 2000 );
|
||
|
|
// returns 366
|
||
|
|
|
||
|
|
num = time.hoursInMonth( 2, 2017 );
|
||
|
|
// returns 672
|
||
|
|
```
|
||
|
|
|
||
|
|
### Timer Utilities
|
||
|
|
|
||
|
|
<!-- <toc keywords="+timer"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`tic()`][@stdlib/time/tic]</span><span class="delimiter">: </span><span class="description">return a high-resolution time.</span>
|
||
|
|
- <span class="signature">[`toc( time )`][@stdlib/time/toc]</span><span class="delimiter">: </span><span class="description">return a high-resolution time difference.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
```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] );
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: better examples -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var objectKeys = require( '@stdlib/utils/keys' );
|
||
|
|
var time = require( '@stdlib/time' );
|
||
|
|
|
||
|
|
console.log( objectKeys( time ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
|
||
|
|
<section class="main-repo" >
|
||
|
|
|
||
|
|
* * *
|
||
|
|
|
||
|
|
## 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-2021. The Stdlib [Authors][stdlib-authors].
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.stdlib -->
|
||
|
|
|
||
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[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
|
||
|
|
[test-url]: https://github.com/stdlib-js/time/actions/workflows/test.yml
|
||
|
|
|
||
|
|
[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
|
||
|
|
|
||
|
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/time.svg
|
||
|
|
[dependencies-url]: https://david-dm.org/stdlib-js/time/main
|
||
|
|
|
||
|
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
||
|
|
[chat-url]: https://gitter.im/stdlib-js/stdlib/
|
||
|
|
|
||
|
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
||
|
|
|
||
|
|
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
||
|
|
|
||
|
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/time/main/LICENSE
|
||
|
|
|
||
|
|
<!-- <toc-links> -->
|
||
|
|
|
||
|
|
[@stdlib/time/tic]: https://www.npmjs.com/package/@stdlib/time/tree/main/tic
|
||
|
|
|
||
|
|
[@stdlib/time/toc]: https://www.npmjs.com/package/@stdlib/time/tree/main/toc
|
||
|
|
|
||
|
|
[@stdlib/time/day-of-quarter]: https://www.npmjs.com/package/@stdlib/time/tree/main/day-of-quarter
|
||
|
|
|
||
|
|
[@stdlib/time/day-of-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/day-of-year
|
||
|
|
|
||
|
|
[@stdlib/time/days-in-month]: https://www.npmjs.com/package/@stdlib/time/tree/main/days-in-month
|
||
|
|
|
||
|
|
[@stdlib/time/days-in-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/days-in-year
|
||
|
|
|
||
|
|
[@stdlib/time/hours-in-month]: https://www.npmjs.com/package/@stdlib/time/tree/main/hours-in-month
|
||
|
|
|
||
|
|
[@stdlib/time/hours-in-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/hours-in-year
|
||
|
|
|
||
|
|
[@stdlib/time/iso-weeks-in-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/iso-weeks-in-year
|
||
|
|
|
||
|
|
[@stdlib/time/minutes-in-month]: https://www.npmjs.com/package/@stdlib/time/tree/main/minutes-in-month
|
||
|
|
|
||
|
|
[@stdlib/time/minutes-in-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/minutes-in-year
|
||
|
|
|
||
|
|
[@stdlib/time/quarter-of-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/quarter-of-year
|
||
|
|
|
||
|
|
[@stdlib/time/seconds-in-month]: https://www.npmjs.com/package/@stdlib/time/tree/main/seconds-in-month
|
||
|
|
|
||
|
|
[@stdlib/time/seconds-in-year]: https://www.npmjs.com/package/@stdlib/time/tree/main/seconds-in-year
|
||
|
|
|
||
|
|
<!-- </toc-links> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|