efd1006 / psgc

Provides PSGC (Philippine Standard Geographic Code) data.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Philippine Standard Geographic Code (PSGC)

Build Status

Provides PSGC (Philippine Standard Geographic Code) data for your application.

Installation

PSGC is available via npm.

$ npm install --save psgc

Or you can use yarn.

$ yarn add psgc

Usage

Import psgc into your app.

import { regions, provinces, municipalities, barangays } from 'psgc';

Use all or find function to get the data you need.

regions.all()                         // To get all regions
regions.find('Ilocos Region')         // Just past region name to get specific region

provinces.all()
provinces.find('La Union')

municipalities.all()
municipalities.find('Agoo')

barangays.all()
barangays.find('San Nicolas East')

TODO

  • Add additional information about regions, provinces, municipalities and barangays
  • Add test

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

License

The package is available as open source under the terms of the MIT License.

About

Provides PSGC (Philippine Standard Geographic Code) data.


Languages

Language:JavaScript 100.0%