Cldr Numbers v2.13.0-rc.0 Cldr.Number.Format.Options View Source

Functions to validate and transform options that guide number formatting

Link to this section Summary

Types

currency_symbol()

fixed_formats()

format()

short_format_styles()

t()

Functions

confirm_currency_format_has_currency_code(options)

ensure_only_valid_keys(valid_options, options)

maybe_set_iso_currency_symbol(options)

resolve_standard_format(options, backend)

set_pattern(options, number)

short_format_styles()

structify(options, module)

validate_option(arg1, options, backend, locale)

validate_options(number, backend, options)

validate_other_format(other_type, backend, options)

wrap_ok(options)

Link to this section Types

currency_symbol()

currency_symbol() :: :standard | :iso

fixed_formats()

fixed_formats() :: :standard | :currency | :accounting | :short | :long

format()

format() :: binary() | fixed_formats()

short_format_styles()

short_format_styles() ::
  :currency_short | :currency_long | :decimal_short | :decimal_long

t()

t() :: %Cldr.Number.Format.Options{
  currency: Cldr.Currency.code(),
  currency_digits: pos_integer(),
  currency_spacing: map(),
  currency_symbol: term(),
  format: format(),
  fractional_digits: pos_integer(),
  locale: Cldr.LanguageTag.t(),
  minimum_grouping_digits: pos_integer(),
  number_system: Cldr.Number.System.system_name(),
  pattern: String.t(),
  round_nearest: pos_integer(),
  rounding_mode: Decimal.rounding(),
  symbols: Cldr.Number.Symbol.t()
}

Link to this section Functions

confirm_currency_format_has_currency_code(options)

ensure_only_valid_keys(valid_options, options)

maybe_set_iso_currency_symbol(options)

resolve_standard_format(options, backend)

set_pattern(options, number)

short_format_styles()

short_format_styles() :: [atom()]

structify(options, module)

validate_option(arg1, options, backend, locale)

validate_options(number, backend, options)

validate_options(Cldr.Math.number_or_decimal(), Cldr.backend(), [
  {atom(), term()}
]) :: {:ok, t()} | {:error, {module(), String.t()}}

validate_other_format(other_type, backend, options)