{"_id":"@codegrenade/naija-faker","_rev":"9-64ad3308090a78ed7d080aa45d005e08","name":"@codegrenade/naija-faker","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.0":{"name":"@codegrenade/naija-faker","version":"1.0.0","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","_id":"@codegrenade/naija-faker@1.0.0","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"homepage":"https://github.com/kodegrenade/naija-faker#readme","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"dist":{"shasum":"d78e7358170460a2d07009a10a046fea4c6a89fb","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.0.tgz","fileCount":14,"integrity":"sha512-04iRSU/emW86QxxAILgUDiw3DSCWZZ/A/0TbAWtBSWBzDdjjduX8m7iaiO/E3Nl1p/eON7nZBswHndk5ZjUmwA==","signatures":[{"sig":"MEQCIDii2QKRDHIQMz0QMrxZa6i6VtFSHAZVgOkENcNQKl6cAiBomDFTZTzAqJqo2evnPgJmq9bmUjC+CMYv8oWg33o1Lg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33632},"main":"index.js","gitHead":"09ef7a596cdea4915566f3d1301b7d415f8179cc","scripts":{"test":"node index.js"},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"repository":{"url":"git+https://github.com/kodegrenade/naija-faker.git","type":"git"},"_npmVersion":"6.14.8","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","directories":{},"_nodeVersion":"14.15.0","dependencies":{},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/naija-faker_1.0.0_1633704987804_0.21649542511742648","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@codegrenade/naija-faker","version":"1.0.1","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","_id":"@codegrenade/naija-faker@1.0.1","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"homepage":"https://github.com/kodegrenade/naija-faker#readme","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"dist":{"shasum":"9682efdec0a199a69bc2af68bdd9aab8bb8ed8e1","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.1.tgz","fileCount":14,"integrity":"sha512-RIt5zTn/kpKwdMnZBB+QovE3az1Ld0Qz4//vFwE8ItN0vHn/dvMjCE53Uh7d1NBErP52QGCDCMcxOUS1qOtsvA==","signatures":[{"sig":"MEYCIQCq85jfToWB1MezgBpFZfrjbkOVU+uzUwhJUT13L2nDNwIhAI8TzJJpbtHimCwx+2YuUgy1gKM4N0VRk4oIzWBCREfp","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33487},"main":"index.js","gitHead":"a29c0cbda9723777f9e50e7a0b5dd805397ef51a","scripts":{"test":"node index.js"},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"repository":{"url":"git+https://github.com/kodegrenade/naija-faker.git","type":"git"},"_npmVersion":"6.14.8","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","directories":{},"_nodeVersion":"14.15.0","dependencies":{},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/naija-faker_1.0.1_1633706055148_0.5271381813698965","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@codegrenade/naija-faker","version":"1.0.2","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","_id":"@codegrenade/naija-faker@1.0.2","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"homepage":"https://github.com/kodegrenade/naija-faker#readme","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"dist":{"shasum":"945e08d0768acf3d600aa046a1db991d0bfbd485","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.2.tgz","fileCount":16,"integrity":"sha512-MkF7yWYlIRt33NZBnwjjYK/WQU6cat+fGFFPd5tTwt1KTYvtEtgzA8bQAUvKZLdGSLfDfD3e9CIst6PTgZuqmA==","signatures":[{"sig":"MEUCIHF+vyArIrV7zjMGb6nYx/KbIyntUwI3T786JwSGf0EjAiEAsm1M0J/jCZsEO9nCnDFUIjoxjS82W8y+/CgPXPJM9Tc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44243},"main":"index.js","gitHead":"899dee5f4cc19b0216281ae0af770f4bd951f8e4","scripts":{"test":"mocha tests/index.test.js"},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"repository":{"url":"git+https://github.com/kodegrenade/naija-faker.git","type":"git"},"_npmVersion":"6.14.8","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","directories":{},"_nodeVersion":"14.15.0","dependencies":{"mocha":"^9.1.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/naija-faker_1.0.2_1633972250530_0.46811108333799045","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@codegrenade/naija-faker","version":"1.0.3","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","_id":"@codegrenade/naija-faker@1.0.3","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"homepage":"https://github.com/kodegrenade/naija-faker#readme","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"dist":{"shasum":"44a08ccb75be712f93be75926c432d37aaf7a9c8","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.3.tgz","fileCount":16,"integrity":"sha512-WUFhmMGJF6Kw97Xq42H5Vj/ZjfYrxso6AqMAzpN2YhkcrFwqBSzqYstpyWIpbSrz7q+4n67WhJdLZ7SlgPbRxA==","signatures":[{"sig":"MEUCIQCcSP/xJbqF9IlTacxhwjPJhe0H9wUE5REcSAm9Kwt6IgIgdpVftuO3F/ucbBEeSaw+Ac/Yu/A1bBK/OGoX9nUDMRI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44245,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzdI6CRA9TVsSAnZWagAA/pcP/jSUFR4G9oSeE/308AUg\ndWlVS+hMvfM3QLp+gQ1baexRDWwcAfAlLIO0/B5Sl4M+L0ujiUGnKW5bp1xD\n5k0KpXu76ubIpem85lCI+EJ2/C5rE+WHBW+LUOqEJ7I7pET/NPsqpGJw/cPt\nWz2dr6B3HgqPcqa9p3p6ncKq8keqthYEx6FXfWqyAVg27XU40IGqZBQpjlWV\nO6q7BRhP8uffwBXAP/tWHfOopDuXB3L9/2OupV7KzMi01+h0qRNezLRQxaNP\n2vR/eH9uqOOEPJwuiQ6CMei10vQ6dOS6eIuxq+7WB+M47Mv62JcL9IPdIV0U\nZg+I91s7sjUe3z6f8HMpwZdDpoJhZ4RRFMCtPQCTidnJu3FJ6WZAEAO4VBCF\nqRhlawm2eelVmDGbcV95YXmPIEdqKQeQuBUOtrathOXrCMdg4cSnhy7/KY+j\n15ltugCUVJ/kQbSp3XALe0jWeEheEiYyMIjbIQb4GqTVtTM/pbqOiWUs7a/T\nAVwJjbRv0RWZId0VhTVtfUxLuGworLRMUPeMBy6z220UoxXdMbE13KKX+lus\npNf9/DOSrigvHijJy8DbKfGFl44TmDbWWhuBjODmCMAsCgt7oeilM7BXGVpK\nSmpJf7b3lPik+oQVnEBinPOBL8Lz5wec30X0iXgJyh87ntv2waQJvb1VFJcC\nQPQF\r\n=7yDp\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"1115058a99cb898d800c6f6acd55ee77fbb24a5c","scripts":{"test":"mocha tests/index.test.js"},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"repository":{"url":"git+https://github.com/kodegrenade/naija-faker.git","type":"git"},"_npmVersion":"6.14.8","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","directories":{},"_nodeVersion":"14.15.0","dependencies":{"mocha":"^9.1.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/naija-faker_1.0.3_1633972468156_0.23318403400384802","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@codegrenade/naija-faker","version":"1.0.4","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","_id":"@codegrenade/naija-faker@1.0.4","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"homepage":"https://github.com/kodegrenade/naija-faker#readme","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"dist":{"shasum":"21a22604a581c17a1fcc0cec630823a6c71a6fe5","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.4.tgz","fileCount":17,"integrity":"sha512-iZ7HstpJWSvyBGhPc3sw4mEfDYLEn4iu15RZ4d41dzv44zfiGqxcQp5AakoYoxCEV2pSawK0CWVNwin5Qds8iQ==","signatures":[{"sig":"MEYCIQDyqhAj/7NgZPAC35RcxO/fhzYTUcMZ3kArLUD1oEWuugIhAK2MexksbTn9FfVFFE0AGsCr9592KozPOaITo8tx3LvP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44487,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjSoNqACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpSFQ/6A83UXOkZR0okbfru1Ozy2iRaJqKKHnylwgNJ1RWSuN9ZuPyv\r\nLqSiMjQSMDtB4AcrPr7tfe8a4mVPXPV6tTvD0qoIm0fvzV3wRyGxdxjplN3u\r\nz5S7JGCKoAyPXifLh6fqjAfRK8vaBOc5Fgo/6/j50oMkEf9Z7ItI5siUH5ew\r\nIy0dUJ3Q23tvgKGF6l6nPUfhhwzZg5WCDylz3FUm6zPCoYFXqzyxSgluwX2Z\r\nDx4sdXgepjeQ97p+blpXRxrMXk0PvWOkaH8tUOlATQ0N9e5EBd4K1T7kI1tJ\r\n5lkvIM9Bw7ygru+RSC0GgqYtou3BhRJk2g+yCGEYTiKRUcl1Ezjal2NMIu3F\r\nPC31D5z7Xrv+F3nNXlL19jH3+9aaiM63/QxTKMSlhwXTkIvw0doS10gOBRw7\r\nOEJvQ5vBuSHTcDZv2pE8oAsG8zYuPBT4/TqTYC9N95KKLHXvg2CadWYsE7oo\r\n5Tuj6UYeV+pYCQFZYu0oR/tGqse3c5BfNqq7Kxwi7Q48Q+15g+rS8Fop+Hrd\r\nt4vDiWJ3vpW11HJtdCA93PdPZNfs9uuiRGkHgkXUMMaetWdmQM2sa5Z3bi6i\r\nTqtH4FczuFPh5hSqForBVC5LFh2kMqB06H/5/1/7+rUFkKtUtwJgNQJ7L/BJ\r\nFRYUSc0ypP6t+psMIyj6ICbwF4vMslWK9Hg=\r\n=1STJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"dc6d3a32057b0201ad6f988c9c3443bd8e8f8958","scripts":{"test":"mocha tests/index.test.js"},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"repository":{"url":"git+https://github.com/kodegrenade/naija-faker.git","type":"git"},"_npmVersion":"8.17.0","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","directories":{},"_nodeVersion":"16.17.0","dependencies":{"mocha":"^9.1.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/naija-faker_1.0.4_1665827690451_0.728700519372206","host":"s3://npm-registry-packages"}},"1.0.5":{"name":"@codegrenade/naija-faker","version":"1.0.5","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","_id":"@codegrenade/naija-faker@1.0.5","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"homepage":"https://github.com/kodegrenade/naija-faker#readme","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"dist":{"shasum":"78994d47130cde67efa05f34f7e242017e16b7ab","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.5.tgz","fileCount":16,"integrity":"sha512-OaRWhpYWOUo8i0DFYyoXv1T+h9+1G8XK/L+/nvMs5HnWC86EXNYqw0+rYr63ZwFXESZJZm1CnvFbpPWAgeriHw==","signatures":[{"sig":"MEQCIFrPpAGicpjy4w5HBx/Om/Ayi0KoDksDaCzgF5dPKmcXAiBeMoJekpHhd+1T5lxI1EGp9JzOHVKbXPcArqJkBZG4vw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44431},"main":"index.js","gitHead":"d7297f32af41e079442472a81469575546212347","scripts":{"test":"mocha tests/index.test.js"},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"repository":{"url":"git+https://github.com/kodegrenade/naija-faker.git","type":"git"},"_npmVersion":"9.8.1","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","directories":{},"_nodeVersion":"18.17.1","dependencies":{"mocha":"^9.1.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/naija-faker_1.0.5_1692376102677_0.5650818165667424","host":"s3://npm-registry-packages"}},"1.0.6":{"name":"@codegrenade/naija-faker","version":"1.0.6","description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","main":"index.js","types":"types/index.d.ts","scripts":{"test":"mocha 'tests/**/*.test.js'"},"repository":{"type":"git","url":"git+https://github.com/kodegrenade/naija-faker.git"},"keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"homepage":"https://github.com/kodegrenade/naija-faker#readme","devDependencies":{"mocha":"^9.1.2"},"_id":"@codegrenade/naija-faker@1.0.6","gitHead":"b6571aae0fa913f11cf790d08e102feb978f0d1e","_nodeVersion":"18.20.8","_npmVersion":"10.8.2","dist":{"integrity":"sha512-DekZ54UlnfVYQgREYif3IJaJ2NquV+DD/UPapKPFPiBOwFIsTSV/MuSJtyn8QuuNWvSD+ufhbmTTQwRHayTqCw==","shasum":"86794faace7e2b1805d7c5fa96bb9e15cfef1c48","tarball":"https://registry.npmjs.org/@codegrenade/naija-faker/-/naija-faker-1.0.6.tgz","fileCount":26,"unpackedSize":123365,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIB0SCGkESABdQYj8dJh0zSWeHAOhXbulTsYDxmBb/t+GAiEAglzVpe+9pFMbRzQ1nChsC8mtUZFZpANVZ2izXHi+jWg="}]},"_npmUser":{"name":"codegrenade","email":"brhamix@gmail.com"},"directories":{},"maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/naija-faker_1.0.6_1771955577013_0.6839404215429272"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-08T14:56:27.720Z","modified":"2026-02-24T17:52:57.314Z","1.0.0":"2021-10-08T14:56:28.007Z","1.0.1":"2021-10-08T15:14:15.352Z","1.0.2":"2021-10-11T17:10:50.653Z","1.0.3":"2021-10-11T17:14:28.298Z","1.0.4":"2022-10-15T09:54:50.684Z","1.0.5":"2023-08-18T16:28:22.869Z","1.0.6":"2026-02-24T17:52:57.203Z"},"bugs":{"url":"https://github.com/kodegrenade/naija-faker/issues"},"author":{"name":"Temitope Ayotunde","email":"brhamix@gmail.com"},"license":"MIT","homepage":"https://github.com/kodegrenade/naija-faker#readme","keywords":["javacript","github","open source","faker","nodejs","javascript faker","nigerian faker","nigerian data","fake data","faker generator"],"repository":{"type":"git","url":"git+https://github.com/kodegrenade/naija-faker.git"},"description":"Naija Faker is a javascript library that generates fake typical nigerian data for you","maintainers":[{"name":"codegrenade","email":"brhamix@gmail.com"}],"readme":"# Naija Faker\n\n[![npm (scoped)](https://img.shields.io/npm/v/@codegrenade/naija-faker.svg)](https://www.npmjs.com/package/@codegrenade/naija-faker)\n[![npm (scoped)](https://img.shields.io/badge/npm-%40codegrenade%2Fnaija--faker-brightgreen.svg)](https://www.npmjs.com/package/@codegrenade/naija-faker)\n[![npm (scoped)](https://img.shields.io/npm/l/@codegrenade/naija-faker)](https://www.npmjs.com/package/@codegrenade/naija-faker)\n\nNaija Faker is a javascript library that generates fake typical Nigerian data ranging from `name`, `address`, `phone number`, `lgas` and `states` for you. It supports **Yoruba**, **Igbo**, and **Hausa** ethnic groups with culturally authentic data.\n\n## Features\n- Authentic Nigerian names (Yoruba, Igbo, Hausa)\n- Phone numbers for all 4 major networks (MTN, Glo, Airtel, 9mobile)\n- Addresses across all Nigerian regions\n- All 37 states (36 states + FCT)\n- 774 Local Government Areas\n- Nigerian-specific titles (Chief, Alhaji, Oba, Emir, Igwe, and more)\n- BVN, NIN, and bank account generation (26 Nigerian banks)\n- License plates, companies, and 42 Nigerian universities\n- Geographically consistent identities (name + state + LGA all match)\n- Detailed persons with education, work, and vehicle records\n- Date of birth, blood group, genotype, marital status\n- Salary generation with level-based income bands\n- Next of kin generation\n- Bulk export to JSON or CSV\n- Seeded deterministic generation for reproducible tests\n- TypeScript support with full IntelliSense\n- AI/LLM integration via `schema.json` and `describe()` method\n\n## Installation\nInstall the package in your existing project\n\n```bash\nnpm install @codegrenade/naija-faker\n```\n\n## Basic Usage/Examples\nImport or require the the package in your project to initialize the faker generator.\n\n```javascript\nimport faker from '@codegrenade/naija-faker'\n```\nor \n\n```javascript\nconst faker = require('@codegrenade/naija-faker')\n```\n\nConfiguration for data choice (**optional**)\n\n> sets default language and gender for names to be generated and the local network provider for phone number\n```javascript\nfaker.config({\n\tlanguage: \"yoruba\",\n\tgender: \"male\",\n\tnetwork: \"glo\",\n})\n\n```\n> NB: `Yoruba`, `Igbo` and `Hausa` are the only Nigerian languages supported at the moment.\n\nGenerate fake data by calling `faker` methods.\n\n```javascript\nfaker.title() // Mrs.\n\nfaker.name() // Temilade Abolade\n\nfaker.address() // 45, Alhaji Kazeem Street, Kaduna\n\nfaker.phoneNumber() // 09123456634\n\nfaker.email() // temilade.abolade@ymail.com\n\nfaker.states() // array of states in Nigeria (36 states + FCT)\n\nfaker.lgas() // array of local government areas in Nigeria\n\n// returns a bank account details\nfaker.bankAccount()\n// → { bankName: 'Zenith Bank', bankCode: '057', accountNumber: '1234567890' }\n\n// returns a BVN (11-digit Bank Verification Number)\nfaker.bvn() // → '22312345678'\n\n// returns a NIN (11-digit National Identification Number)\nfaker.nin() // → '98765432101'\n```\n\n```javascript\n// call to person method\nfaker.person() \n\n// object of person details\n{\n  title: 'Engr.',\n  firstName: 'Akintunde',\n  lastName: 'Owoyele',\n  fullName: 'Akintunde Owoyele',\n  email: 'akintunde.owoyele@gmail.com',\n  phone: '+2349093636382',\n  address: '63, Ebubedike Uzoma Avenue, Awka'\n}\n```\n\n> If you want a person of a particular language and gender\n\n```javascript\n// returns person details of a male from the hausa language\nfaker.person(\"hausa\", \"male\") \n```\n\n\n```javascript\n// call to people method\nfaker.people()\n\n// array of person objects\n[\n  {\n    title: 'Engr.',\n    firstName: 'Akintunde',\n    lastName: 'Owoyele',\n    fullName: 'Akintunde Owoyele',\n    email: 'akintunde.owoyele@gmail.com',\n    phone: '+2349093636382',\n    address: '63, Ebubedike Uzoma Avenue, Awka'\n  }\n  {\n    title: 'Mr.',\n    firstName: 'Olayinka',\n    lastName: 'Adedayo',\n    fullName: 'Olayinka Adedayo',\n    email: 'olayinka.adedayo@hotmail.fr',\n    phone: '+2348189416772',\n    address: 'Km 9, Lanre Ayotunde Crescent, Ilorin'\n  }\n]\n```\n> The `people` method returns 10 persons by default. If you want more persons to be returned by the method, use the example below.\n\n```javascript\nfaker.people(20) // returns 20 persons in the array\n```\n\n### Specifing desired parameter values\n```javascript\n// returns a male title\nfaker.title(\"male\") \n\n// returns an igbo language name\nfaker.name(\"igbo\") \n\n// returns a yoruba name for the male gender\nfaker.name(\"yoruba\", \"male\") \n\n// returns a phone number from the mtn network\nfaker.phoneNumber(\"mtn\")\n\n// returns an email address from the name supplied\nfaker.email(\"Aboderin Joshua\")\n\n// returns a bank account for a specific bank\nfaker.bankAccount(\"Access Bank\")\n```\n\n## Seeded Generation\n\nUse `faker.seed()` for reproducible output — perfect for snapshot testing and consistent test fixtures.\n\n```javascript\nfaker.seed(12345)\nfaker.name(\"yoruba\", \"male\") // Always returns the same name\nfaker.person(\"igbo\")         // Always returns the same person\n\nfaker.seed(12345)            // Reset to same seed\nfaker.name(\"yoruba\", \"male\") // Identical output as above\n\nfaker.seed()                 // Reset to non-deterministic mode\n```\n\n## Consistent Identities\n\nGenerate persons where name ethnicity, address, state, and LGA are all geographically coherent.\n\n```javascript\nfaker.consistentPerson(\"yoruba\", \"male\")\n\n// → All fields match: Yoruba name, western address, western state, matching LGA\n{\n  title: 'Chief',\n  firstName: 'Adebayo',\n  lastName: 'Ogunlesi',\n  fullName: 'Adebayo Ogunlesi',\n  email: 'adebayo.ogunlesi@gmail.com',\n  phone: '+2348031234567',\n  address: 'Plot 45, Oluwaseun Adedayo Street, Ibadan',\n  state: 'Oyo',\n  lga: 'Ibadan North'\n}\n```\n\n```javascript\n// Generate multiple consistent people\nfaker.consistentPeople(5, \"hausa\", \"female\")\n// → 5 Hausa female persons, all with northern states and matching LGAs\n```\n\n## License Plates, Companies & Universities\n\n```javascript\n// Generate a Nigerian license plate\nfaker.licensePlate() // → 'LAG-234XY'\nfaker.licensePlate(\"Kano\") // → 'KAN-891AB'\n\n// Generate a Nigerian company\nfaker.company()\n// → { name: 'Pan-African Solutions Ltd', rcNumber: 'RC-1234567', industry: 'Technology' }\n\n// Generate a Nigerian university\nfaker.university()\n// → { name: 'University of Lagos', abbreviation: 'UNILAG', state: 'Lagos', type: 'federal' }\n```\n\n## Records\n\n```javascript\nfaker.educationRecord(\"yoruba\")\n// → { university: 'University of Lagos', abbreviation: 'UNILAG', degree: 'B.Sc', course: 'Computer Science', graduationYear: 2019 }\n\nfaker.workRecord()\n// → { company: 'Pan-African Solutions Ltd', position: 'Senior Analyst', industry: 'Technology', startYear: 2019 }\n\nfaker.vehicleRecord(\"Lagos\")\n// → { licensePlate: 'LAG-234XY', make: 'Toyota', model: 'Corolla', year: 2021, color: 'Silver' }\n```\n\n## Detailed Person\n\nGenerate a rich identity with education, work, and vehicle records — all geographically coherent.\n\n```javascript\nfaker.detailedPerson(\"yoruba\", \"male\")\n\n{\n  title: 'Chief',\n  firstName: 'Adebayo',\n  lastName: 'Ogunlesi',\n  fullName: 'Adebayo Ogunlesi',\n  email: 'adebayo.ogunlesi@gmail.com',\n  phone: '+2348031234567',\n  address: 'Plot 45, Oluwaseun Adedayo Street, Ibadan',\n  state: 'Oyo',\n  lga: 'Ibadan North',\n  dateOfBirth: { date: '1990-03-15', age: 35 },\n  maritalStatus: 'Married',\n  bloodGroup: 'O+',\n  genotype: 'AA',\n  salary: {\n    amount: 450000,\n    currency: 'NGN',\n    level: 'mid',\n    frequency: 'monthly'\n  },\n  nextOfKin: {\n    fullName: 'Folake Adeyemi',\n    relationship: 'Spouse',\n    phone: '+2348091234567',\n    address: '12, Akinola Crescent, Ibadan'\n  },\n  education: {\n    university: 'University of Ibadan',\n    abbreviation: 'UI',\n    degree: 'B.Sc',\n    course: 'Computer Science',\n    graduationYear: 2019\n  },\n  work: {\n    company: 'Pan-African Solutions Ltd',\n    position: 'Software Engineer',\n    industry: 'Technology',\n    startYear: 2020\n  },\n  vehicle: {\n    licensePlate: 'OYO-234XY',\n    make: 'Toyota',\n    model: 'Corolla',\n    year: 2021,\n    color: 'Silver'\n  }\n}\n```\n\n```javascript\n// Generate multiple detailed people\nfaker.detailedPeople(5, \"igbo\", \"female\")\n```\n\n## Personal Data\n\n```javascript\nfaker.dateOfBirth() // → { date: '1990-03-15', age: 35 }\nfaker.dateOfBirth({ minAge: 25, maxAge: 40 }) // custom range\n\nfaker.maritalStatus() // → 'Married'\nfaker.bloodGroup() // → 'O+'\nfaker.genotype() // → 'AS'\n```\n\n## Salary\n\n```javascript\nfaker.salary()\n// → { amount: 450000, currency: 'NGN', level: 'mid', frequency: 'monthly' }\n\nfaker.salary({ level: 'executive' })\n// → { amount: 3500000, currency: 'NGN', level: 'executive', frequency: 'monthly' }\n```\n\n## Next of Kin\n\n```javascript\nfaker.nextOfKin(\"yoruba\", \"male\")\n// → { fullName: 'Adebayo Ogunlesi', relationship: 'Brother', phone: '+234...', address: '...' }\n```\n\n## Bulk Export\n\n```javascript\n// Export as JSON string\nfaker.export(\"person\", 5) // 5 persons as JSON\n\n// Export as CSV\nfaker.export(\"person\", 5, \"csv\")\n// → title,firstName,lastName,fullName,email,phone,address\\n...\n\n// Export detailed persons (nested fields are flattened in CSV)\nfaker.export(\"detailedPerson\", 10, \"csv\")\n```\n\n## Custom Providers\n\nExtend naija-faker with your own data generators:\n\n```javascript\n// Register a custom provider\nfaker.registerProvider('religion', (f) => {\n  const religions = ['Christianity', 'Islam', 'Traditional']\n  return religions[Math.floor(f._random() * religions.length)]\n})\n\nfaker.generate('religion') // → 'Islam'\n\n// Complex return types work too\nfaker.registerProvider('vehicle_insurance', (f) => ({\n  provider: 'AXA Mansard',\n  policyNumber: `POL-${Math.floor(f._random() * 900000 + 100000)}`,\n  type: 'comprehensive',\n}))\n\nfaker.generate('vehicle_insurance')\n// → { provider: 'AXA Mansard', policyNumber: 'POL-482917', type: 'comprehensive' }\n\n// List registered providers\nfaker.listProviders() // → ['religion', 'vehicle_insurance']\n```\n\n> **Note:** Custom providers receive the faker instance as an argument — use `f._random()` instead of `Math.random()` for seeded deterministic output.\n\n## Error Handling\n\nAll validation errors throw a `NaijaFakerError` with a machine-readable `code`:\n\n```javascript\nconst faker = require('@codegrenade/naija-faker')\n\n// Access via property\nconst { NaijaFakerError } = faker\n\ntry {\n  faker.name(\"klingon\")\n} catch (err) {\n  if (err instanceof faker.NaijaFakerError) { ... }\n}\n```\n\n| Error Code | Methods |\n|-----------|---------|\n| `INVALID_LANGUAGE` | `name()`, `config()`, `consistentPerson()`, `detailedPerson()` |\n| `INVALID_GENDER` | `config()` |\n| `INVALID_NETWORK` | `phoneNumber()`, `config()` |\n| `INVALID_STATE` | `licensePlate()` |\n| `INVALID_BANK` | `bankAccount()` |\n| `INVALID_LEVEL` | `salary()` |\n| `INVALID_TYPE` | `export()` |\n| `INVALID_PARAM` | `config()`, `phoneNumber()` |\n\n## TypeScript Support\n\nNaija Faker ships with TypeScript declarations out of the box. You get full IntelliSense and type checking with no additional setup.\n\n```typescript\nimport faker from '@codegrenade/naija-faker'\n\nconst person = faker.person(\"yoruba\", \"female\")\n// Full autocomplete for person.title, person.firstName, etc.\n```\n\n## AI/LLM Integration\n\nNaija Faker is designed to work seamlessly with AI agents and LLM-powered development tools.\n\n### Runtime Introspection\n\nUse the `describe()` method to discover available methods at runtime:\n\n```javascript\n// Get schema for all methods\nfaker.describe()\n\n// Get schema for a specific method\nfaker.describe('person')\n// Returns: { name: 'person', description: '...', parameters: [...], returns: {...}, example: {...} }\n```\n\n### Schema File\n\nA `schema.json` file is included in the package, providing a full JSON Schema description of the API. AI agents can use this for tool discovery:\n\n```javascript\nconst schema = require('@codegrenade/naija-faker/schema.json')\n```\n\n## Contributing\nPlease feel free to fork the package and contribute by submitting a pull request to enhance the functionlities.\n\n## License\nNaija Faker is release under the MIT License. See [`LICENSE`](LICENSE) for details.\n\n## Feedback\nIf you have any feedback, please reach out to me at brhamix@gmail.com\n\n## Author\n- [@kodegrenade](https://www.github.com/kodegrenade)\n","readmeFilename":"readme.md"}