ActionView::Helpers::NumberHelper for Elixir
Elixir Shell Ruby
Clone or download

README.md

Number

Build Status Inline docs Coverage Status

Number is a pretentiously-named Elixir library which provides functions to convert numbers into a variety of different formats. Ultimately, it aims to be a partial or complete clone of ActionView::Helpers::NumberHelper from Rails.

Number.Currency.number_to_currency(2034.46)
"$2,034.46"

Number.Phone.number_to_phone(1112223333, area_code: true, country_code: 1)
"+1 (111) 222-3333"

Number.Percentage.number_to_percentage(100, precision: 0)
"100%"

Number.Human.number_to_human(1234)
"1.23 Thousand"

Number.Delimit.number_to_delimited(12345678)
"12,345,678"

Installation

Get it from Hex:

defp deps do
  [{:number, "~> 0.5.7"}]
end

Then run mix deps.get.

Extra step for Elixir 1.3 and lower

If you're running Elixir 1.3 or lower, don't forget to add it under your applications list in mix.exs:

def application do
  [applications: [:number]]
end

Elixir 1.4 and higher doesn't need to add the package to the applications list.

Usage

If you want to import all of the functions provided by Number, simply use it in your module:

defmodule MyModule do
  use Number
end

More likely, you'll want to import the functions you want from one of Number's submodules.

defmodule MyModule do
  import Number.Currency
end

See the Hex documentation for more information about the modules provided by Number.

License

MIT. See LICENSE for more details.