Utility for extracting and validating phone numbers. Extracts an array of phone numbers from an inputted string, validates that these numbers appear genuine and provide data about those phone numbers.

Scripts

Install devDependencies

npm i

Formatting source code

npm run format

Linting

npm run lint

Testing

npm test

Code Coverage Report

npx vitest run --coverage

Release Process

This package is automatically published to NPM via GitHub Actions when a new version tag is pushed.

To publish a new version:

1. Bump the version using one of these commands:

   npm run version:patch  # For bug fixes (0.4.0 → 0.4.1)
   npm run version:minor  # For new features (0.4.0 → 0.5.0)
   npm run version:major  # For breaking changes (0.4.0 → 1.0.0)

2. Push the changes and tags:

   npm run release

   This will run tests, linting, and push both commits and tags to GitHub.

3. GitHub Actions will automatically:

   • Run tests and linting
   • Publish to NPM with provenance
   • Use OIDC authentication for secure publishing

⚠️ SECURITY WARNING

The rawNumber field contains UNSANITIZED user input and poses XSS risks if displayed in web applications.

🚨 NEVER do this:

// DANGEROUS - Direct HTML insertion
document.getElementById('phone').innerHTML = result.rawNumber;

// DANGEROUS - Template literal insertion
element.innerHTML = `Call ${result.rawNumber}`;

// DANGEROUS - React without escaping
return <div>{result.rawNumber}</div>;

✅ Safe approaches:

// SAFE - Use formatted version for display
document.getElementById('phone').textContent = result.formattedNumber;

// SAFE - Use rawNumber for string replacement/processing
const updatedText = originalText.replace(
  result.rawNumber,
  result.formattedNumber,
);

// SAFE - Escape before HTML insertion
document.getElementById('phone').innerHTML = escapeHtml(result.rawNumber);

// SAFE - React with proper text content
return <div>{result.formattedNumber}</div>;

Why rawNumber exists:

The rawNumber field enables powerful text replacement functionality:

const text = 'Call me at (310) 555-1234 anytime!';
const numbers = findNumbersInString(text);
let updatedText = text;

numbers.forEach((phone) => {
  // Replace original with formatted version
  updatedText = updatedText.replace(phone.rawNumber, phone.formattedNumber);
});
// Result: "Call me at (310) 555-1234 anytime!" → formatted consistently

Warning

The returned object will include a rawNumber value. This value is the return of the exact value passed to the function. No sanitization occurs with this value. If you reference this number, ensure you sanitize it BEFORE passing to this function.

Install

npm i @yext/phonenumber-util --save

Usage

There is additional functionality exposed as export, but the primary expected use case is:

isValidPhoneNumber

Returns a boolean based on whether the passed number is presumed to be valid or invalid.

This checks for region code, number length and validity of region code and area code (where applicable).

import { isValidPhoneNumber } from '@yext/phonenumber-util';
const validPhoneNumber = '3103496333';
isValidPhoneNumber(validPhoneNumber); // Returns `true` - "310" is an area code for California

const invalidPhoneNumber = '3113496333';
isValidPhoneNumber(invalidPhoneNumber); // Returns `false` - "311" is not a valid area code

const intlNumber = '+380 97 123 4567';
isValidPhoneNumber(intlNumber); // Returns `true` - "380" is the region code for Ukraine

const invalidIntlNumber = '+000 97 123 4567';
isValidPhoneNumber(invalidIntlNumber); // Returns `false` - "000" is not a valid region code

isValidPhoneNumberWithDescription

Returns an object that will contain a boolean of isValid which will behave exactly the same as isValidPhoneNumber (true or false based on whether the passed number is presumed to be valid or invalid) in addition to a string description that will contain one of the following values:

• NOT_A_NUMBER - The passed value is falsey (null, empty string, undefined or 0) or the passed value is not the expected string format.
• UNKNOWN_NUMBER - The portion of the phone number including the region code and/or local number is unrecognized, unexpected or invalid.
• UNKNOWN_AREA_CODE - The NANP number includes an area code of the correct length but cannot be validated. If you believe this to be in error, please file a Github Issue.
• VALID_NUMBER - When isValid is true, this description will always read VALID_NUMBER.
• UNKNOWN_FORMAT - There were issues parsing the provided number and does not appear to be a valid phone number structure.

import { isValidPhoneNumberWithDescription } from '@yext/phonenumber-util';
const validPhoneNumber = '3103496333';
isValidPhoneNumberWithDescription(validPhoneNumber); // Returns { description: 'VALID_NUMBER', isValid: true }

const invalidPhoneNumber = '3113496333';
isValidPhoneNumberWithDescription(invalidPhoneNumber); // Returns { description: 'UNKNOWN_NUMBER', isValid: false }

const intlNumber = '+380 97 123 4567';
isValidPhoneNumberWithDescription(intlNumber); // Returns { description: 'VALID_NUMBER', isValid: true }

const invalidIntlNumber = '+000 97 123 4567';
isValidPhoneNumberWithDescription(invalidIntlNumber); // Returns { description: 'UNKNOWN_NUMBER', isValid: false }

getPhoneParts

Return an object of relevant phone number parts and information.

import { getPhoneParts } from '@yext/phonenumber-util';
const validPhoneNumber = '3496333';
getPhoneParts(validPhoneNumber); // Returns an object, assumed to be US / Canada, region code "1" but no area code can be reliably determined.

const validPhoneNumber = '+923331234567';
getPhoneParts(validPhoneNumber); // Returns an object, assumed to be Pakistan, region code "92".

Example output for Pakistan ("+923331234567"):

{
  areaCode: null,
  e164: "+923331234567",
  format: "+xx xxx xxx xxxx",
  formattedNumber: "+92 333 123 4567",
  href: "tel:+923331234567",
  localNumber: "3331234567",
  rawNumber: "+923331234567",
  regionCode: "92"
}

Example for US with 7 digits provided ("3496200") where no state can be determined. Note that e164 and formattedNumber also cannot be derived:

{
  areaCode: null,
  e164: null,
  format: "(xxx) xxx-xxxx",
  formattedNumber: null,
  href: "tel:3496200",
  localNumber: "3496200",
  rawNumber: "349.6200",
  regionCode: "1"
}

Example for US with full area code provided ("310.349.9999"):

{
  areaCode: "310",
  e164: "+13103499999",
  format: "(xxx) xxx-xxxx",
  formattedNumber: "(310) 349-9999",
  href: "tel:+13103499999",
  localNumber: "3103499999",
  rawNumber: "310.349.9999",
  regionCode: "1"
}

findNumbersInString

Accepts a full string of text and returns an array of phone numbers extracted from within that text.

The objects within this array will be identical to the object provided in the getPhoneParts above with the only exception being the addition of a index and lastIndex integer noting the start and end of the instance of that specific number within the provided string.

Example for US with full area code provided ("Hey there, my number is 310.349.9999. Please give me a call!"):

[
  {
    index: 24,
    lastIndex: 36,
    areaCode: '310',
    e164: '+13103499999',
    format: '(xxx) xxx-xxxx',
    formattedNumber: '(310) 349-9999',
    href: 'tel:+13103499999',
    localNumber: '3103499999',
    rawNumber: '310.349.9999',
    regionCode: '1',
  },
];

Numbers that lack area codes will NOT be returned via findNumbersInString since they cannot be reliably validated.

Example for US with no area code provided ("Hey there, my number is 349.9999. Please give me a call!"):

[];

Geography / Time Functionality

In addition to the above methods, the following methods are also available via a different export.

There is additional functionality exposed as export, but the primary expected use case is:

findTimeFromAreaCode

Returns an object with geographic and time related information for a given region.

NOTE: This is only applicable for United States and Canada.

import { findTimeFromAreaCode } from '@yext/phonenumber-util/geo';
findTimeFromAreaCode('928');

Example output for Arizona:

{
  areaCodeHasMultipleTimezones: false,
  daylightSavings: true,
  estimatedTime: true,
  isQuietHours: false,
  isTCPAQuietHours: false,
  localTime24Hour: "15:00:00",
  localTimeReadable: "3:00:00 PM",
  region: {
    code: "US",
    flag: "🇺🇸",
    name: "United States"
  },
  state: {
    code: "AZ",
    name: "Arizona"
  },
  stateHasMultipleTimezones: false,
  timezoneOffset: "-07:00"
}

import { findTimeFromAreaCode } from '@yext/phonenumber-util/geo';
findTimeFromAreaCode('250', date); // A date object is optional, defaulting to the current time.

Example output for British Columbia:

{
  areaCodeHasMultipleTimezones: true,
  daylightSavings: true,
  estimatedTime: true,
  isCRTCQuietHours: false,
  isQuietHours: false,
  localTime24Hour: "17:00:00",
  localTimeReadable: "5:00:00 PM",
  region: {
    code: "CA",
    flag: "🇨🇦",
    name: "Canada"
  },
  state: {
    code: "BC",
    name: "British Columbia"
  },
  stateHasMultipleTimezones: true,
  timezoneOffset: "-07:00"
}

findRegionFromRegionCode

import { findRegionFromRegionCode } from '@yext/phonenumber-util/geo';
findRegionFromRegionCode('47');

Returns the string name of a given region name based on region code provided.

NOTE: This string is provided in English only (example: "Norway" and not the region-specific name "Norge").

{
  code: "NO",
  flag: "🇳🇴",
  name: "Norway"
}