Naija Faker is a javascript library that generates fake typical nigerian data ranging from name, address, phone number, lgas and states for you.
Install the package in your existing project
npm install @codegrenade/naija-fakerImport or require the the package in your project to initialize the faker generator.
import faker from '@codegrenade/naija-faker'or
const faker = require('@codegrenade/naija-faker)Configuration for data choice (optional)
sets default language and gender for names to be generated and the local network provider for phone number
faker.config({
language: "yoruba",
gender: "male",
network: "glo",
})NB:
Yoruba,IgboandHausaare the only Nigerian languages supported at the moment.
Generate fake data by calling faker methods.
faker.title() // Mrs.
faker.name() // Temilade Abolade
faker.address() // 45, Alhaji Kazeem Street, Kaduna
faker.phoneNumber() // 09123456634
faker.email() // [email protected]
faker.states() // array of states in Nigeria
faker.lgas() // array of states in Nigeria// call to person method
faker.person()
// object of person details
{
title: 'Engr.',
firstName: 'Akintunde',
lastName: 'Owoyele',
fullName: 'Akintunde Owoyele',
email: '[email protected]',
phone: '+2349093636382',
address: '63, Ebubedike Uzoma Avenue, Awka'
}If you want a person of a particular language and gender
// returns person details of a male from the hausa language
faker.person("hausa", "male") // call to people method
faker.people()
// array of person objects
[
{
title: 'Engr.',
firstName: 'Akintunde',
lastName: 'Owoyele',
fullName: 'Akintunde Owoyele',
email: '[email protected]',
phone: '+2349093636382',
address: '63, Ebubedike Uzoma Avenue, Awka'
}
{
title: 'Mr.',
firstName: 'Olayinka',
lastName: 'Adedayo',
fullName: 'Olayinka Adedayo',
email: '[email protected]',
phone: '+2348189416772',
address: 'Km 9, Lanre Ayotunde Crescent, Ilorin'
}
]The
peoplemethod returns 10 persons by default. If you want more persons to be returned by the method, use the example below.
faker.peole(20) // returns 20 persons in the array// returns a male title
faker.title("male")
// returns an igbo language name
faker.name("igbo")
// returns a yoruba name for the male gender
faker.name("yoruba", "male")
// returns a phone number from the mtn network
faker.phoneNumber("mtn")
// returns an email address from the name supplied
faker.email("Aboderin Joshua")Please feel free to fork the package and contribute by submitting a pull request to enhance the functionlities.
Naija Faker is release under the MIT License. See LICENSE for details.
If you have any feedback, please reach out to me at [email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent