Cldr.Calendar.Duration.to_string

You're seeing just the function to_string, go back to Cldr.Calendar.Duration module for more information.

to_string(duration, options \\ [])

Returns a string formatted representation of a duration.

Note that time units that are zero are ommitted from the output.

Formatting is

Arguments

duration is a duration of type t() returned by Cldr.Calendar.Duration.new/2
options is a Keyword list of options

Options

:except is a list of time units to be omitted from the formatted output. It may be useful to use except: [:microsecond] for example. The default is [].
locale is any valid locale name returned by Cldr.known_locale_names/1 or a Cldr.LanguageTag struct returned by Cldr.Locale.new!/2 The default is Cldr.get_locale/0
backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0
:list_options is a list of options passed to Cldr.List.to_string/3 to control the final list output.

Any other options are passed to Cldr.Number.to_string/3 and Cldr.Unit.to_string/3 during the formatting process.

Note

Any duration parts that are 0 are not output.

Example

iex> {:ok, duration} = Cldr.Calendar.Duration.new(~D[2019-01-01], ~D[2019-12-31])
iex> Cldr.Calendar.Duration.to_string(duration)
{:ok, "11 months and 30 days"}