number v0.3.1 → Overview → Number → Delimit

Number.Delimit

Provides functions to delimit numbers into strings.

Summary↑

number_to_delimited(number, options \\ [])

Formats a number into a string with grouped thousands using delimiter

Functions

number_to_delimited(number, options \\ [])
(function) # ↑

Specs:

  • number_to_delimited(number, list) :: String.t

Formats a number into a string with grouped thousands using delimiter.

Parameters

  • number - A float or integer to convert.

  • options - A keyword list of options. See the documentation of all available options below for more information.

Options

  • :precision - The number of decimal places to include. Default: 2

  • :delimiter - The character to use to delimit the number by thousands. Default: ","

  • :separator - The character to use to separate the number from the decimal places. Default: "."

Default config for these options can be specified in the Number application configuration.

config :number, delimiter: [
                  precision: 3,
                  delimiter: ",",
                  separator: "."
                ]

Examples

iex> Number.Delimit.number_to_delimited(nil)
nil

iex> Number.Delimit.number_to_delimited(-234234.234)
"-234,234.23"

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

iex> Number.Delimit.number_to_delimited(12345678.05)
"12,345,678.05"

iex> Number.Delimit.number_to_delimited(12345678, delimiter: ".")
"12.345.678"

iex> Number.Delimit.number_to_delimited(12345678, delimiter: ",")
"12,345,678"

iex> Number.Delimit.number_to_delimited(12345678.05, separator: " ")
"12,345,678 05"

iex> Number.Delimit.number_to_delimited(98765432.98, delimiter: " ", separator: ",")
"98 765 432,98"