Naija-faker NPM

issues forks stars

naija-faker

This package helps you generate fake Nigerian data on the fly for use in your projects.

Getting Started

To get started, follow the instructions below

install the package npm install naija-faker
import it in your app using:

// if using ES6
import naijaFaker from "naija-faker";

// or

import {
  getFirstName,
  getLastName,
  getPerson,
  getPersonList,
  getNameList,
  getBank,
  getState,
  getPhoneNumber,
  getAddress,
} from "naija-faker";

// without ES6
const naijaFaker = require("naija-faker");

use it!

naijaFaker.getFirstName();

Available methods

Generate an array of people with first name, last name, age, bank, state and phone number

To generate an array of people, simply pass an amt value to getPersonList() i.e getPersonList({amt: 2})
NB: Default amt is 5

getPersonList({ amt: 2 });
//outputs:
[
  {
    fName: "abdul",
    lName: "qadr",
    age: 40,
    email: "abdul.qadr@hey.com",
    state: "ekiti",
    phoneNumber: "+234-805-940-4016",
    address: "102b, opebi road, opebi, abakaliki",
  },
  {
    fName: "frank",
    lName: "edoho",
    age: 23,
    email: "frank.edoho@gmail.com",
    state: "delta",
    phoneNumber: "+234-705-261-5977",
    address: "223, ambeez plaza, zone 5, onne",
  },
];

Generate a random First name or Last name

getFirstName() //=> 'abraham'
getLastName() //=> 'fatai'

Generate a random First name or Last name that starts with a letter/letters

getFirstName('r') //=> 'rahman'
getLastName('bo') //=> 'bolanle'

Generate a person Object with random values for First name, Last name and Age

NB: Default age is between 18 - 50

getPerson();
// outputs:
    {
      fName: 'abdul', lName: 'qadr', age: 20,
      email: 'abdul.qadr@hey.com', state:'ekiti',
      phoneNumber:'+234-805-940-4016', address: 'plaza 1121, odunuga street, igboho'
    }

To change the default min and max values for age, pass in min and max values as an object like below.

getPerson({ min: 20, max: 50 });
// outputs:
  {
     fName: 'abdul', lName: 'qadr', age: 40,
     email: 'abdul.qadr@hey.com', state:'ekiti', bank:'Access bank', phoneNumber:'+234-805-940-4016',
     networkProvider: 'Globacom',
     address: '9329, stanton oval, kwara, kosofe'
  }