Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/time-duration2ms
Convert a duration string to milliseconds.
https://github.com/stdlib-js/time-duration2ms
duration javascript milliseconds ms node node-js nodejs stdlib str string time util utilities utility utils
Last synced: about 2 months ago
JSON representation
Convert a duration string to milliseconds.
- Host: GitHub
- URL: https://github.com/stdlib-js/time-duration2ms
- Owner: stdlib-js
- License: apache-2.0
- Created: 2022-10-27T23:50:34.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T01:58:37.000Z (9 months ago)
- Last Synced: 2024-05-01T12:01:07.156Z (8 months ago)
- Topics: duration, javascript, milliseconds, ms, node, node-js, nodejs, stdlib, str, string, time, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 460 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# duration2ms
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert a duration string to milliseconds.
## Installation
```bash
npm install @stdlib/time-duration2ms
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var duration2ms = require( '@stdlib/time-duration2ms' );
```
#### duration2ms( str )
Converts a duration string to milliseconds.
```javascript
var ms = duration2ms( '1d' );
// returns 86400000
ms = duration2ms( '1d2h3m4s5ms' );
// returns 93784005
```
## Notes
- A duration string is a string containing a sequence of time units. A time unit is a nonnegative 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).
- Duration strings are case insensitive. For example, the string `1M3S10MS` is equivalent to `1m3s10ms`.
## Examples
```javascript
var duration2ms = require( '@stdlib/time-duration2ms' );
var ms = duration2ms( '5s20ms' );
// returns 5020
ms = duration2ms( '1h' );
// returns 3600000
ms = duration2ms( '1m2s3ms' );
// returns 62003
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/time-duration2ms-cli
```
### Usage
```text
Usage: duration2ms [options] []
Options:
-h, --help Print this message.
-V, --version Print the package version.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
```
### Notes
- If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
```bash
# Not escaped...
$ echo -n $'3s\n5s20ms' | duration2ms --split /\r?\n/
# Escaped...
$ echo -n $'3s\n5s20ms' | duration2ms --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
### Examples
```bash
$ duration2ms 1s
1000
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n '1s\n2s' | duration2ms
1000
2000
```
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
```bash
$ echo -n '1s350ms,2s' | duration2ms --split ','
1350
2000
```
* * *
## 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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/time-duration2ms.svg
[npm-url]: https://npmjs.org/package/@stdlib/time-duration2ms
[test-image]: https://github.com/stdlib-js/time-duration2ms/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/time-duration2ms/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/time-duration2ms/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/time-duration2ms?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
[cli-section]: https://github.com/stdlib-js/time-duration2ms#cli
[cli-url]: https://github.com/stdlib-js/time-duration2ms/tree/cli
[@stdlib/time-duration2ms]: https://github.com/stdlib-js/time-duration2ms/tree/main
[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-duration2ms/tree/deno
[deno-readme]: https://github.com/stdlib-js/time-duration2ms/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/time-duration2ms/tree/umd
[umd-readme]: https://github.com/stdlib-js/time-duration2ms/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/time-duration2ms/tree/esm
[esm-readme]: https://github.com/stdlib-js/time-duration2ms/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/time-duration2ms/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/time-duration2ms/main/LICENSE
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions