This package helps you generate fake Nigerian data on the fly for use in your projects.
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();- To generate an array of people, simply pass an
amtvalue togetPersonList()i.egetPersonList({amt: 2}) - NB: Default
amtis 5
getPersonList({ amt: 2 });
//outputs:
[
{
fName: "abdul",
lName: "qadr",
age: 40,
email: "[email protected]",
state: "ekiti",
phoneNumber: "+234-805-940-4016",
address: "102b, opebi road, opebi, abakaliki",
},
{
fName: "frank",
lName: "edoho",
age: 23,
email: "[email protected]",
state: "delta",
phoneNumber: "+234-705-261-5977",
address: "223, ambeez plaza, zone 5, onne",
},
];getFirstName() //=> 'abraham'getLastName() //=> 'fatai'
getFirstName('r') //=> 'rahman'getLastName('bo') //=> 'bolanle'
- NB: Default age is between 18 - 50
getPerson();
// outputs:
{
fName: 'abdul', lName: 'qadr', age: 20,
email: '[email protected]', state:'ekiti',
phoneNumber:'+234-805-940-4016', address: 'plaza 1121, odunuga street, igboho'
}- To change the default
minandmaxvalues 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: '[email protected]', state:'ekiti', bank:'Access bank', phoneNumber:'+234-805-940-4016',
networkProvider: 'Globacom',
address: '9329, stanton oval, kwara, kosofe'
}-
Simply pass
amttogetNameList()e.gNB: Default
amtis 5
getNameList({ amt: 5 });- Simply call
getState() //=> 'Ondo'
- Simply call
getBank() //=> 'Access Bank'
- Simply call
getAddress() //=> 'Plot 83, Nasarawa, Bauchi'
- Simply call
getPhoneNumber() //=> '+234-805-940-4016'
- To run the tests
npm install
npm test
👤 Adebola Adeniran
- Github: @githubhandle
- Twitter: @twitterhandle
- Linkedin: linkedin
- Web: Adebola
👤 Mayank Bucha
- Github: @githubhandle
- Linkedin: linkedin
- Email: gmail
👤 Nikhil Chaurasia
Give a ⭐️ if you like this project!
This project is MIT licensed.