Giter VIP home page Giter VIP logo

phil-reg-prov-mun-brgy's Introduction

Description

A Javascript library to get the regions, provinces, cities, municipalities and barangays in the Philippines


Installation

Via NPM

npm i phil-reg-prov-mun-brgy

or

Via <script> Tag

  • Download the phil.min.js from the build folder
  • Include to HTML file <script type="text/javascript" src="path_to/phil.min.js">

Usage

Via NPM

var phil = require('phil-reg-prov-mun-brgy')

or

import phil from 'phil-reg-prov-mun-brgy'

You can also import properties and methods

import { regions, getProvincesByRegion, ... } from 'phil-reg-prov-mun-brgy'

var phil = require('phil-reg-prov-mun-brgy');
console.log(phil.regions);

or

import phil from 'phil-reg-prov-mun-brgy';
console.log(phil.barangays);

Via Script Tag

<script type="text/javascript" src="path_to/phil.min.js">

You can now access the 'Philippines' object globally window.Philippines or Philippines

<script type="text/javascript" src="path_to/phil.min.js">
<script type="text/javascript">
     Philippines.getProvincesByRegion('01');
     console.log(Philippines.provinces);
</script>

Properties and methods

Property Type Description
regions Array List of all regions
provinces Array List of all provinces
city_mun Array List of all cities and municipalities
barangays Array List of all barangays
getProvincesByRegion Function Provinces in the selected region. Parameter (region_code)
getCityMunByProvince Function Cities and Municipalities in the selected Province. Parameter (province_code)
getBarangayByMun Function Barangays in the selected City. Parameter (mun_code)
sort Function Sorts the array. Parameters (arr, sort = 'A' or 'Z')

Credits

National Statistical Coordination Board clavearnel

phil-reg-prov-mun-brgy's People

Contributors

ejcubillas avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.