@stdlib/assert-is-duration-string
v0.2.2
Published
Test if a value is a duration string.
Downloads
21
Readme
isDurationString
Test if a value is a duration string.
Installation
npm install @stdlib/assert-is-duration-string
Usage
var isDurationString = require( '@stdlib/assert-is-duration-string' );
isDurationString( value )
Tests if a value
is a duration string
.
var bool = isDurationString( '1d' );
// returns true
bool = isDurationString( '1d2h' );
// returns true
Notes
The function validates that a
value
is astring
. For all other types, the function returnsfalse
.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
: daysh
: hoursm
: minutess
: secondsms
: milliseconds
For example, the string
1m3s10ms
is a duration string containing three time units:1m
(1 minute),3s
(3 seconds), and10ms
(10 milliseconds). The string60m
is a duration string containing a single time unit:60m
(60 minutes). Time units must be supplied in descending order of magnitude (i.e., days, hours, minutes, seconds, milliseconds).Duration strings are case insensitive. For example, the string
1M3S10MS
is equivalent to1m3s10ms
.
Examples
var isDurationString = require( '@stdlib/assert-is-duration-string' );
var bool = isDurationString( '1h' );
// returns true
bool = isDurationString( '1m20ms' );
// returns true
bool = isDurationString( '1d 2h 3m 4s' );
// returns false
bool = isDurationString( 'beep' );
// returns false
bool = isDurationString( null );
// returns false
See Also
@stdlib/assert-is-duration-string-cli
: CLI package for use as a command-line utility.
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
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.