chilean-territory-code
v1.2.9
Published
get territory names, codes, and a list of cities by levenshtein proximity search
Downloads
16
Maintainers
Readme
Package Name
A Node.js package for checking territorial names and codes using the Levenshtein distance algorithm. github source code
only valid for Chilean territory, and always returns the closest value, without exception
Installation
Use npm to install the package:
npm install chilean-territory-code
API
Input params
- criteria: keyword referencial as 'Valpo'
- scope : 'city'|'province'|'region'
import * as cut from 'chilean-territory-code';
const basic = cut.getTerritory('criteria', scope);
/**
* returns{
* name:string,
* leven:number //word proximity
* type:string, //territorial scope city | province | region
* index: number //data source location
* }
*/
const withCodes = cut.getCut('criteria', scope);
/**
* by CUT from spanish UNIQUE TERRITORIAL CODE
* returns{
* city?:string,
* city_code?:string
* province?:string,
* province_code?:string
* region:string,
* region_code:string,
* region_acronym:string
* }
*/
// UPDATE: now you fetch all territorial cities, searching by related in province or regional
/**
* @function getCitiesList
* @param keyword referencial word for search criteria
* @param keyword_scope level of territorial scope of keyword, is a city?, is a region?.
* @param scope level of territorial scope on returns, can be all provincial cities or all regional cities.
* @returns cities in CUT format.
*/
const listOfCities = cut.getCitiesList('criteria?', 'criteria scope?', scope); // on undefined returns all communes, on default scope = 'city'
/**
* returns Array<{
* city?:string,
* city_code?:string
* province?:string,
* province_code?:string
* region:string,
* region_code:string,
* * region_acronym:string
* }>
*/