tanzanian-phone-validator v1.1.5

Tanzanian Phone Number Validation

A simple npm package for validating Tanzanian phone numbers using regular expressions.

Installation

You can install this package via npm:

npm i tanzanian-phone-validator

Example

You can check an example of this library Here.

Here is how it look like:

Usage

Use the isValidPhoneNumber function to validate a phone number. It returns true if the phone number is valid and false otherwise.

Use the getPhoneNumberDetails function to get information about a phone number. It returns an object various information about the phone number as shown below:

const results = {
  isValid: true,
  telecomCompanyDetails: {
    prefix: 76,
    company: "Vodacom Tanzania Limited",
    brand: "Vodacom",
    operational: "yes",
  },
};

Usage with validation libraries

Here are some usage examples with different validation libraries:

Using Yup

const yup = require("yup");
import { isValidPhoneNumber } from "tanzanian-phone-validator";

const schema = yup.object({
  phoneNumber: yup
    .string()
    .test("is-tanzanian", "Invalid Tanzanian phone number", (value) => {
      return isValidPhoneNumber(value);
    }),
});

// Example usage
const data = {
  phoneNumber: "+255761234567",
};

schema
  .validate(data)
  .then((validatedData) => {
    console.log("Validation succeeded:", validatedData);
  })
  .catch((error) => {
    console.error("Validation failed:", error.message);
  });

Using Zod

const { z } = require("zod");
import { validateTanzanianPhoneNumber } from "tanzanian-phone-validator";

const schema = z.object({
  phoneNumber: z.string().refine(
    (value) => {
      return isValidPhoneNumber(value);
    },
    {
      message: "Invalid Tanzanian phone number",
    }
  ),
});

// Example usage
const data = {
  phoneNumber: "+255761234567",
};

try {
  const validatedData = schema.parse(data);
  console.log("Validation succeeded:", validatedData);
} catch (error) {
  console.error("Validation failed:", error.message);
}

Direct usage (Node Js)

You can also directly use the isValidPhoneNumber function:

import { validateTanzanianPhoneNumber } from "tanzanian-phone-validator";

const phoneNumber = "+255761234567";

if (isValidPhoneNumber(phoneNumber)) {
  console.log("Valid Tanzanian phone number.");
} else {
  console.log("Invalid Tanzanian phone number.");
}

List of Tanzanian mobile network operators and their prefixes

This table was used to used to create this package. IT can be found in wikipedia (Click here).. Note : this package does not validate for Operators which are not in Operation nor on this table.

License This package is licensed under the MIT License. See the LICENSE..