Formats a phone number using the libphonenumber-js library.

format-phone-number.mjs

import parsePhoneNumber from "libphonenumber-js";

/**
 * @typedef {Object} FormatPhoneNumberType - creates a new type named "FormatPhoneNumberType"
 * @property {string} number - The phone number to format.
 * @property {"NATIONAL" | "INTERNATIONAL" | "RFC3966"} [property="INTERNATIONAL"] - The desired formatting property.
 */

/**
 * Formats a phone number using the libphonenumber-js library.
 *
 * @param {FormatPhoneNumberType} options - The options for formatting the phone number.
 * @returns {string} - The formatted phone number string.
 *
 * @example
 *
 * const formattedNumber = formatPhoneNumber({
 *   number: '+12133734253',
 *   property: 'NATIONAL'
 * });
 * console.log(formattedNumber); // Output: "(213) 373-4253"
 */
export function formatPhoneNumber(options) {
  const { number, property = "INTERNATIONAL" } = options;
  const phoneNumber = parsePhoneNumber(number);

  if (!phoneNumber || !phoneNumber.isValid()) {
    return number;
  }

  return phoneNumber.format(property);
}