municipalities.md

Municipalities Usage

Introduction

You can use CommonJS modules or ES modules syntax for importing the Municipality entity.

import { Municipality } from 'states-nepal' // ES6

or

const { Municipality } = require('states-nepal') // CommonJS

By default, english language will be used. In order to use Nepali language, you have to specify while initiating the municipality object.

import { Municipality } from 'states-nepal'

// English language will be selected by default
const municipality = new Municipality()

Or, You can specify nepali language :

import { Municipality } from 'states-nepal'

const municipality = new Municipality('np')

Retrieving Municipalities

Once you create instance of Municipality, you can retrieve variety of data.

1. Get list of all districts

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.allMunicipalities()

2. Find municipality details by unique identifier

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.find(1)

3. Get array of municipalities by district Id

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.getMunicipalitiesByDistrict(7)

4. Get municipality with largest area

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.largest()

5. Get municipality with smallest area

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.smallest()

6. Get array of municipalities by category Id

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.getMunicipalityByCategory(4)

7. Get all wards of a municipality with given municipality Id.

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

municipality.wards(4)

8. Search municipalities by key and value with exact match option

import { Municipality } from 'states-nepal'

const municipality = new Municipality()

// examples
district.search('name', 'Chandragiri') // (key, value)
district.search('id', 312)
district.search('district_id', 27)
district.search('category_id', 4)

List of options for parameter key:

'id', 'district_id', 'category_id', 'name', 'area_sq_km', 'website', 'wards'