number_to_phone(number, options = {})
Instance Public methods
Formats a number into a US phone number (e.g., (555)
123-9876). You can customize the format in the options hash.
Options
-
:area_code- Adds parentheses around the area code. -
:delimiter- Specifies the delimiter to use (defaults to â-â). -
:extension- Specifies an extension to add to the end of the generated number. -
:country_code- Sets the country code for the phone number. -
:raise- If true, raisesInvalidNumberErrorwhen the argument is invalid.
Examples
number_to_phone(5551234) # => 555-1234
number_to_phone("5551234") # => 555-1234
number_to_phone(1235551234) # => 123-555-1234
number_to_phone(1235551234, area_code: true) # => (123) 555-1234
number_to_phone(1235551234, delimiter: " ") # => 123 555 1234
number_to_phone(1235551234, area_code: true, extension: 555) # => (123) 555-1234 x 555
number_to_phone(1235551234, country_code: 1) # => +1-123-555-1234
number_to_phone("123a456") # => 123a456
number_to_phone("1234a567", raise: true) # => InvalidNumberError
number_to_phone(1235551234, country_code: 1, extension: 1343, delimiter: ".")
# => +1.123.555.1234 x 1343
Please login to continue.