telephonecheck

ts-phone-validator

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("[phone]")); // 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

Issues

If you encounter any issues, please report them Here

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on GitHub.

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Create a new Pull Request.

License

MIT

Acknowledgements

• Inspired by common phone number validation techniques and patterns.

Tech Stack

Badges

Authors

• @neryad