Package Exports

@stdlib/time
@stdlib/time/day-of-quarter
@stdlib/time/day-of-year
@stdlib/time/days-in-month
@stdlib/time/days-in-year
@stdlib/time/hours-in-month
@stdlib/time/hours-in-year
@stdlib/time/iso-weeks-in-year
@stdlib/time/minutes-in-month
@stdlib/time/minutes-in-year
@stdlib/time/now
@stdlib/time/quarter-of-year
@stdlib/time/seconds-in-month
@stdlib/time/seconds-in-year
@stdlib/time/tic
@stdlib/time/toc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/time) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Time

Standard library time utilities.

Installation

npm install @stdlib/time

Usage

var time = require( '@stdlib/time' );

time

Standard library time utilities.

var ns = time;
// returns {...}

Calendar Utilities

dayOfQuarter( [month[, day, year]] ): determine the day of the quarter.
dayOfYear( [month[, day, year]] ): determine the day of the year.
daysInMonth( [month[, year]] ): determine the number of days in a month.
daysInYear( [value] ): determine the number of days in a year according to the Gregorian calendar.
hoursInMonth( [month[, year]] ): determine the number of hours in a month.
hoursInYear( [value] ): determine the number of hours in a year according to the Gregorian calendar.
isoWeeksInYear( [value] ): determine the number of ISO weeks in a year according to the Gregorian calendar.
minutesInMonth( [month[, year]] ): determine the number of minutes in a month.
minutesInYear( [value] ): determine the number of minutes in a year according to the Gregorian calendar.
quarterOfYear( [month] ): determine the quarter of the year.
secondsInMonth( [month[, year]] ): determine the number of seconds in a month.
secondsInYear( [value] ): determine the number of seconds in a year according to the Gregorian calendar.

var num = time.daysInYear( 2000 );
// returns 366

num = time.hoursInMonth( 2, 2017 );
// returns 672

Timer Utilities

tic(): return a high-resolution time.
toc( time ): return a high-resolution time difference.

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] );
}

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var time = require( '@stdlib/time' );

console.log( objectKeys( time ) );

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.

License

See LICENSE.

@stdlib/time