geo-ng
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

geo-ng

geo-ng is an npm package that provides data related to geographic locations in Nigeria.

Installation

You can install geo-ng via npm or yarn:

npm install geo-ng

or

yarn add geo-ng

Usage

Get List of Nigerian States

import { getNigeriaStates } from 'geo-ng';

const nigeriaStates = getNigeriaStates();
console.log(nigeriaStates);

Get Local Government Areas (LGAs) of a State

import { getLGAs } from 'geo-ng';

const lgas = getLGAs('AB');
console.log(lgas);

Get Areas/Sub-Areas of an LGA

import { getLgaSubAreas } from 'geo-ng';

const subAreas = getLgaSubAreas("AB", "ABA NORTH");
console.log(subAreas);

API

The geo-ng package provides the following API:

  • getNigeriaStates(): Returns a list of Nigerian states with their codes.
  • getLGAs(stateCode: string): Returns the Local Government Areas (LGAs) of a specified state.
  • getLgaSubAreas(stateCode: string, lga: string): Returns the areas/sub-areas of a specified LGA.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

Attribution

The states, local government areas (LGAs), and sub-areas data in this package are sourced from https://govote.ng/, a website providing information related to geographic locations in Nigeria. This data was used to update and enhance the geographic data in the geo-ng package. Visit https://govote.ng/ for more details.

Package Sidebar

Install

npm i geo-ng

Weekly Downloads

7

Version

1.0.5

License

ISC

Unpacked Size

541 kB

Total Files

13

Last publish

Collaborators

  • ayobamiu