ms

Tiny millisecond conversion utility, inspired by the npm ms package.

Why

Elixir's :timer module works but only accepts numbers:

:timer.hours(2)    #=> 7200000
:timer.minutes(30) #=> 1800000

ms lets you use human-readable strings, which is nicer for configs, timeouts, and user input:

Ms.parse("2h")      #=> 7200000
Ms.parse("1h 30m")  #=> 5400000
Ms.parse("7 days")  #=> 604800000

Installation

Add ms to your list of dependencies in mix.exs:

def deps do
  [
    {:ms, "~> 1.0"}
  ]
end

Usage

Parsing

Ms.parse("2h")      #=> 7200000
Ms.parse("1.5h")    #=> 5400000
Ms.parse("1h 30m")  #=> 5400000
Ms.parse("100")     #=> 100
Ms.parse("nope")    #=> :error
Ms.parse!("2h")     #=> 7200000

Formatting

Ms.format(7200000)              #=> "2h"
Ms.format(7200000, long: true)  #=> "2 hours"
Ms.format(60000)                #=> "1m"

Supported units