@stdlib/time-ms2duration
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

ms2duration

NPM version Build Status Coverage Status

Convert a number of milliseconds to a string duration.

Installation

npm install @stdlib/time-ms2duration

Usage

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

ms2duration( str )

Converts a number of milliseconds to a string duration.

var duration = ms2duration( 1030 );
// returns '1s30ms'

duration = ms2duration( 3600000 );
// returns '1h'

Notes

  • A duration string is a string containing a sequence of time units. A time unit is a non-negative integer followed by a unit identifier. The following unit identifiers are supported:

    • d: days
    • h: hours
    • m: minutes
    • s: seconds
    • ms: milliseconds

    For example, the string 1m3s10ms is a duration string containing three time units: 1m (1 minute), 3s (3 seconds), and 10ms (10 milliseconds). The string 60m is a duration string containing a single time unit: 60m (60 minutes).

Examples

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

var duration = ms2duration( 1030 );
// returns '1s30ms'

duration = ms2duration( 3600000 );
// returns '1h'

duration = ms2duration( 0 );
// returns '0ms'

duration = ms2duration( 86400000 );
// returns '1d'

duration = ms2duration( 86400000+3600000+60000+1000+100 );
// returns '1d1h1m1s100ms'

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/time-ms2duration

Homepage

stdlib.io

Weekly Downloads

5

Version

0.2.1

License

Apache-2.0

Unpacked Size

27.4 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser