Telephonecheck NPM

ts-phone-validator

npm npm npm GitHub issues GitHub last commit

ts-phone-validator is a TypeScript package that helps you validate if a telephone number is well-written according to common formats.

Features

Validates phone numbers with optional country codes.
Supports various phone number formats including spaces, dashes, and parentheses.
Easy to use and integrate into any Dart or Flutter project.

Installation

You can install this package using npm:

npm i telephonecheck

Or using yarn:

yarn add telephonecheck

Usage

First, import the telephoneCheck function from the package:

import telephoneCheck from 'ts-phone-validator';

const number = "555-555-5555";
const isValid = telephoneCheck(number);
console.log(`Is the number valid? ${isValid}`);

Function

` telephoneCheck(str: string): boolean

Parameters:
- str: A string representing the phone number to validate.
Returns:
- boolean: Returns true if the phone number is valid, otherwise false.

Examples

import telephoneCheck from 'ts-phone-validator';

console.log(telephoneCheck("555-555-5555")); // true
console.log(telephoneCheck("(555) 555-5555")); // true
console.log(telephoneCheck("555 555 5555")); // true
console.log(telephoneCheck("5555555555")); // true
console.log(telephoneCheck("123")); // false
console.log(telephoneCheck("abc-def-ghij")); // false