https://github.com/orimdominic/ng-streets
A utility library for retrieving Nigerian states, local government areas, and street names. (help wanted
https://github.com/orimdominic/ng-streets
areas local-government location ng-streets nigeria nigerian-states npm state street
Last synced: 3 months ago
JSON representation
A utility library for retrieving Nigerian states, local government areas, and street names. (help wanted
- Host: GitHub
- URL: https://github.com/orimdominic/ng-streets
- Owner: orimdominic
- Created: 2021-01-06T02:51:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-17T23:54:31.000Z (over 4 years ago)
- Last Synced: 2025-02-16T16:09:38.877Z (8 months ago)
- Topics: areas, local-government, location, ng-streets, nigeria, nigerian-states, npm, state, street
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ng-streets
- Size: 161 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
Awesome Lists containing this project
README
# ng-streets
A utility library for retrieving Nigerian states, local government areas and street data.
## Getting Started
### Prerequisites
- Node (>=8.10.0)
- npm or Yarn
### Installing
Add the package to your project from the npm registry using `npm` or `yarn` with
```
npm install ng-streets
```
or
```
yarn add ng-streets
```
## How to use
Data types
```ts
State: >
Area: >
Street:
```
### Methods
getStates
Returns an array of the contained data of every state in Nigeria.
```js
const { getStates } = require('ng-streets');
const data = getStates();
console.log(data);
/*
[
{name: 'Abia', geoPol: 'South East', areas; [...]},
...,
{name: 'Zamfara', geoPol: 'North West', areas; [...]}
]
*/
```
getState
Returns the contained data of a state in the dataset.
* **name** name of the state
```js
const { getState } = require('ng-streets');
const data = getState('lagos');
console.log(data);
// {name: 'Lagos', geoPol: 'South West', areas; [...]}
```
## Contributing
Please read [CONTRIBUTING.md](https://github.com/sudo-kaizen/ng-streets/CONTRIBUTING.MD) for details on our code of conduct, and the process for submitting pull requests to us.
To add street data without modifying the codebase, please fill the [Nigerian Streets Data form](https://forms.gle/2SdvUuEGPudnPFpY6).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/sudo-kaizen/ng-streets/tags).
## Authors
* **Orim Dominic Adah** - *Initial work* - [sudo-kaizen](https://github.com/sudo-kaizen)
See also the list of [contributors](https://github.com/sudo-kaizen/ng-streets/contributors) who participated in this project.