kenya-administrative-divisions

Effortlessly retrieve the names of Kenya's counties, constituencies, and wards

Table of Contents

• Install
• Usage
• Get all
• Get counties
• Get constituencies
• Get wards

Features

• Get names,codes and constituencies of all counties in kenya
• Get names and wards of all constituences in kenya
• Get names of all wards in kenya

Install

# npm
npm install kenya-administrative-divisions

# pnpm
pnpm install kenya-administrative-divisions

# yarn
yarn add kenya-administrative-divisions

Usage

Once the package is installed you use the require approach

const kenyaAdministrativeDivisions = require("kenya-administrative-divisions");

Or you can use the import approach

import {getAll,getConstituencies,getWards,getCounties} from "kenya-administrative-divisions";

NB: Every function returns a promise

Get all

This will retrieve all counties,their names,their code and their constituencies. The constituencies will also include the ward names. Do not pass parameters to this function.

// When using require approach
const kenyaAdministrativeDivisions = require("kenya-administrative-divisions");

kenyaAdministrativeDivisions.getAll().then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});  

// when using import approach
import {getAll,getConstituencies,getWards,getCounties} from "kenya-administrative-divisions";

// get all function 
getAll().then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});  

All examples shown below use the require approach if you are using the import approach just remove kenyaAdministrationDivisons before the function call

Get counties

This will retrieve information about counties.

const kenyaAdministrativeDivisions = require("kenya-administrative-divisions");
// To get all counties and their county code
kenyaAdministrativeDivisions.getCounties().then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});

// To get the information  of a particular county pass the county name 
kenyaAdministrativeDivisions.getCounties("nairobi").then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});

// Or the county code
kenyaAdministrativeDivisions.getCounties(47).then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});

Get constituencies

This will retrieve information about constituencies

const kenyaAdministrativeDivisions = require("kenya-administrative-divisions");

// To get all constituencies
kenyaAdministrativeDivisions.getConstituencies().then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});  

// To get information about a particular constituency pass the constituency name to the function
kenyaAdministrativeDivisions.getConstituencies("Westlands").then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});  

// To get all constituencies of a particular county pass the county code as a parameter
kenyaAdministrativeDivisions.getConstituencies(1).then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
}); 

Get wards

This will retrieve all information about wards

const kenyaAdministrativeDivisions = require("kenya-administrative-divisions");
// To get all the wards
kenyaAdministrativeDivisions.getWards().then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});

// To get a particular ward pass the name of the wards as a parameter
kenyaAdministrativeDivisions.getWards("Kitisuru").then((data) => {
    console.log(data);
    }).catch((error) => {
    console.log(error);
});

// To get the wards of a particular county, pass the county code to the function
kenyaAdministrativeDivisions.getWards(47).then((data)=>{
    console.log(data);
}).catch((error)=>{
    console.log(error)
})

Contributing

1. Fork this repository.
2. Create new branch with feature name.
3. Create your feature.
4. Commit and set commit message with feature name.
5. Push your code to your fork repository.
6. Create pull request.

Support

If you like this project, You can support me with starring ⭐ this repository.

License

MIT

Made with 💙