Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

simple-duration

1.0.1 • Public • Published

simple-duration

npm version

A JavaScript library to convert seconds to strings and back using a human readable format.

simple-duration is an implementation of the Simple Duration Format 1.0.

Examples:

import * as sd from 'simple-duration'
 
const i = sd.parse('3h 10m 52s') // i = 11452
 
console.log(sd.stringify(+ 10)) // prints 3h 11m 2s

Installation

npm install simple-duration

Usage

parse(str)

Parses a string using the Simple Duration Format and returns the number of seconds corresponding to it.

stringify(seconds, rounding='ms')

Formats a number of seconds. The rounding is using the milliseconds as default value but you can pass any other unit as defined bellow.

Format

Here are the possible units:

  • y - A Julian year, which means 365.25 days.
  • d - 24 hours.
  • h - 60 minutes.
  • m - 60 seconds.
  • s - A second according to the SI.
  • ms - 10e-3 seconds.
  • µs - 10e-6 seconds.
  • ns - 10e-9 seconds.

You can specify any number of units in any order. As example 24s 3h is perfectly valid. You can also specify negative amounts of time like -3m.

When formatting the stringify function will always use a normalizing process.

License

See the license file.

Contribution

See the contribution file.

Install

npm i simple-duration

DownloadsWeekly Downloads

132

Version

1.0.1

License

MIT

Unpacked Size

23.7 kB

Total Files

11

Last publish

Collaborators

  • avatar