rwanda
v2.1.6
Published
This package provides you access to provinces, districts, sectors, villages and cells found in Rwanda
Downloads
1,186
Maintainers
Readme
rwanda
This is a simple npm package that returns provinces, districts, sectors, villages and cells found in Rwanda.
Rwanda is organized in four provinces in addition to the Kigali city, 30 Districts, 416 Sectors, 2148 Cells and 14 837 Villages.
Example
const { Provinces, Districts } = require('rwanda');
console.log(Provinces()); // [ 'East', 'Kigali', 'North', 'South', 'West' ]
console.log(Districts()); // [ 'Bugesera', 'Gatsibo', 'Kayonza', 'Kirehe',...]
And how to get districts of a given province
const { Districts } = require('rwanda');
console.log(Districts('kigali')); // [ 'Gasabo', 'Kicukiro', 'Nyarugenge' ]
console.log(Districts('Kigali', 'South')); // [ 'Gasabo', 'Kicukiro', 'Nyarugenge', 'Huye',.... ]
Methods
Usage
const { Provinces, Districts, Sectors, Cells, Villages } = require('rwanda');
All inputs are case-insensitive.
Provinces()
Returns array of country provinces.
['East', 'Kigali', 'North', 'South', 'West'];
Districts()
By default it returns an array of country districts, if no params (province) is given
Districts(province)
If province is given it returns an array of districts found in that province. It returns
undefined
if province is not found.
Sectors()
By default it returns array of country sectors, if no params (province, district) are given
Sectors(province, district)
If province and district are given it returns an array of sectors found from the given district in that province. It returns
undefined
if either province or district is not found.
Cells()
By default it returns an array of all country cells.
Cells(province, district, sector)
if province, district and sector are given it returns an array of Cells found from the given sector. It returns
undefined
if either province, district or sector is not found.
Villages()
By default it returns an array of all country villages.
Villages(province, district, sector, cell)
if province, district, sector and cell are given it returns an array of Villages found from the given cell. It returns
undefined
if either province, district , sector or cell is not found.
Install
npm install rwanda
or
yarn add rwanda
Contributors
Contribution
- Please before making a PR, read first this Contributing Guideline
License
MIT
Author
Igwaneza Bruce