get-nigerian-network-provider

A simple utility package to determine the network service provider based on Nigerian phone number

Get the network service provider's name of a Nigerian phone number through its number prefix

example:

| Phone Number | Network Service Provider | | ------------ | ------------------------ | | 0803 | MTN | | 0911 | AIRTEL | | 0708 | GLO | | 0905 | 9MOBILE |

Table of Contents

• Installation
• Usage
• Contributing
• Author
• Acknowledgements
• Show your support
• License

Installation

You can install the package using npm:

npm install nigerian-network-provider

Usage

Import the package in your code using ES6 import syntax:

import getServiceProvider from "nigerian-network-provider";

or using CommonJS require syntax:

const getServiceProvider = require("nigerian-network-provider");

To get the service provider name of a phone number, simply call the getServiceProvider function and pass the phone number as an argument.

const phoneNumber = "07066079012";
const result = getServiceProvider(phoneNumber);
console.log(result);

The result will be an object with the serviceProvider property indicating the detected service provider and the isValid property indicating that the phone number is valid.

{
  isValid: true,
  serviceProvider: "MTN"
}

If the phone number is invalid, the result will be an object with the isValid property set to false and the error property set to a string indicating the error.

// invalid number

const result = getServiceProvider("invalidNumber");
console.log(result);

{
  isValid: false,
  error: "Please enter a valid phone number"
}

If the phone number is valid but the service provider is not found, the result will be an object with the isValid property set to false and the error property set to a string indicating the error.

// network service provider not found

const result = getServiceProvider("+e2349011234545");

{
  isValid: false,
  error: "network service provider not found"
}

Example

Here's an example of using the package to determine the service provider of a Nigerian phone number:

import getServiceProvider from "nigerian-network-provider";

const result = getServiceProvider("07061260712");
//or
const result = getServiceProvider("+2347061260712");
//or
const result = getServiceProvider("2347061260712");
// it also accepts numbers with minimum of 4 digits Prefix
const result = getServiceProvider("0912");
console.log(result);

// Output:

 {
   isValid: true,
   serviceProvider: "MTN"
 }

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and test thoroughly.
4. Create a pull request.

Author

Nwaohiri Emmanuel

Acknowledgements

• NCC National numbering plan mobile number allocation october 2022

• Prefix for All Nigerian Phone Numbers (2023 Update) from Awajis.com

• Nigerian Phone Number Validator npm package

Show your support

Give a ⭐️ if you like this project!

License

This project is licensed under the ISC License. See the LICENSE file for details.

Feel free to customize the content further to match your project's specifics and preferences.