Merge pull request #1 from patrickojeh/feature/get-zones-list

Feature/get zones list

.github/workflows/main.yml

@@ -7,15 +7,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: ['10.x', '12.x', '14.x']
+        node: ['18.x', '20.x']
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
 
       - name: Use Node ${{ matrix.node }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
 

README.md

@@ -1,4 +1,5 @@
-# Nigerian Geopolitical Zones Data 
+# Nigerian Geopolitical Zones Data ![NPM Version](https://img.shields.io/npm/v/nigerian-geopolitical-zones)
+
 
 This library contains in JSON format, Nigerian states with their various geopolitical zones. Other data includes:
 - Area (in Km2)
@@ -24,9 +25,12 @@ Example:
 // Utils
 import { getAllZones, getZoneData, getZoneByState } from 'nigerian-geopolitical-zones';
 
-// All 36 states (incl. FCT) with their zones
+// All 36 states (plus. FCT) with their zones
 getAllZones();
 
+// Names of all zones
+getZonesList();
+
 // All states that fall in a zone
 getZoneData('south east');
 getZoneData('south-east');

src/data/zones.json

@@ -461,6 +461,20 @@
     "yearCreated": 1976,
     "zone": "North West"
   },
+  {
+    "state": "Taraba",
+    "areaKm2": 54473,
+    "capitalCity": "Jalingo",
+    "coordinates": {
+      "latitude": 8.0000,
+      "longitude": 10.5000
+    },
+    "motto": "Nature's Gift to the Nation",
+    "population": 3331885,
+    "populationRank": null,
+    "yearCreated": 1991,
+    "zone": "North East"
+  },
   {
     "state": "Yobe",
     "areaKm2": 45502,

src/index.ts

@@ -1,3 +1,4 @@
 export { default as getAllZones } from './lib/getAllZones';
+export { default as getZonesList } from './lib/getZonesList';
 export { default as getZoneData } from './lib/getZoneData';
 export { default as getZoneByState } from './lib/getZoneByState';

src/lib/getZonesList.ts

@@ -0,0 +1,15 @@
+import zones from "../helpers/fetchZones";
+
+/**
+ * Function that returns an array containing only the names of the 6 geopolitical zones in Nigeria
+ * @returns {Array<string>}
+ */
+function getZonesList(): string[] {
+  const list: string[] = zones.map(item => item.zone);
+
+  const uniqueList: Set<string> = new Set(list);
+
+  return Array.from(uniqueList);
+}
+
+export default getZonesList;

test/getAllZones.test.ts

@@ -1,4 +1,4 @@
-import getAllZones from '../src/lib/getAllZones';
+import { getAllZones } from '../src/index';
 import { ZonesInterface } from '../src/shared/interfaces';
 
 describe('functionality to get data for all zones', () => {

test/getZoneByState.test.ts

@@ -1,4 +1,4 @@
-import getZoneByState from '../src/lib/getZoneByState';
+import { getZoneByState } from '../src/index';
 import { ZonesInterface } from '../src/shared/interfaces';
 
 describe('functionality to get data for a particular state', () => {

test/getZoneData.test.ts

@@ -1,4 +1,4 @@
-import getZoneData from '../src/lib/getZoneData';
+import { getZoneData } from '../src/index';
 import { ZonesInterface } from '../src/shared/interfaces';
 
 describe('functionality to get data for a particular zone', () => {

test/getZonesList.test.ts

@@ -0,0 +1,11 @@
+import { getZonesList } from '../src/index';
+
+describe('functionality to return just the names of all geopolitical zones', () => {
+  test('should return an array containing strings of 6 items', () => {
+    const zones: string[] = getZonesList();
+
+    expect(Array.isArray(zones)).toBeTruthy();
+    expect(zones.length == 6).toBeTruthy();
+    expect(typeof zones[0] === 'string').toBeTruthy();
+  })
+})