JSPM

@stdlib/assert-is-duration-string

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q22951F
  • License Apache-2.0

Test if a value is a duration string.

Package Exports

  • @stdlib/assert-is-duration-string
  • @stdlib/assert-is-duration-string/lib/index.js

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/assert-is-duration-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isDurationString

NPM version Build Status Coverage Status

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 a string. For all other types, the function returns false.

  • 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). 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 to 1m3s10ms.

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

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/assert-is-duration-string

Usage

Usage: is-duration-string [options] [<string>]

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, ensure that the split option is either properly escaped or enclosed in quotes.

    # Not escaped...
$ echo -n $'3m20s\n50ms' | is-duration-string --split /\r?\n/
# Escaped...
$ echo -n $'3m20s\n50ms' | is-duration-string --split /\\r?\\n/

  • The implementation ignores trailing delimiters.

Examples

$ is-duration-string '1h'
true

To use as a standard stream,

$ echo -n '1x' | is-duration-string
false

By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

$ echo -n '1h2m3s\tboop' | is-duration-string --split '\t'
true
false

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 © 2016-2022. The Stdlib Authors.