Method: UnitMeasurements::Formatter#to_fs

Defined in:
lib/unit_measurements/formatter.rb

#to_fs(format = nil) ⇒ String

Formats measurement to certain formatted string specified by format. If format is not specified, it uses DEFAULT_FORMAT for formatting the measurement.

The #to_fs method allows for customization of the output format of a measurement. It uses format placeholders for quantity and unit.

Examples:

UnitMeasurements::Length.new(1, "m").to("in").to_fs
=> "39.37 in"

UnitMeasurements::Length.new(1, "m").to("in").to_fs("%.4<quantity>f %<unit>s")
=> "39.3701 in"

Parameters:

  • format (String, optional) (defaults to: nil) —

    The custom format string for formatting the measurement. If not provided, DEFAULT_FORMAT is used.

Returns:

  • (String) —

    A formatted string representing the measurement.

See Also:

Author:

Since:

  • 5.10.0



53
54
55
56
 
# File 'lib/unit_measurements/formatter.rb', line 53

def to_fs(format = nil)
  kwargs = {quantity: quantity, unit: unit.to_s}
  (format || DEFAULT_FORMAT) % kwargs
end