@usig-gcba/callejero
v1.1.1
Published
Modulo para la carga de direcciones de la Ciudad de Buenos Aires
Downloads
70
Readme
Gestor de calles de CABA
Esta libreria cuenta con los datos de todas las calles de la Ciudad de Buenos Aires. Se puede utilizar tanto en el cliente como en Node.js.
##Instalación
npm install @usig-gcba/callejero
##Uso
Todas las funciones se exportan dentro de un mismo objeto. Para utilizarlas, se debe importar la libreria mediante import Core from '@usig-gcba/callejero'
.
###Funciones
#####init(options)
El método init inicializa al componente, y devuelve una Promise que se resuelve al terminar de cargar los datos de las calles, devolviendo una referencia al objeto que contiene todas las funciones.
Callejero.init(options).then((res) => {
//Los datos han sido cargados en este punto
})
Este inicializador puede recibir un objeto de opciones de configuración. Los parametros posibles son los siguientes:
| Parámetro | Descripcion | Default |
|:------------------:|:------------------------------------------------------:|---------|
| lazyDataLoad | Los datos se cargan al inicializarse en caso de false | false |
| loadFullDatabase | Carga la base de datos de calles completa | true |
| callesEnMinusculas | Carga los nombres de las calles en minuscula | false |
#####cargarCalles()
Carga los datos de las calles en caso de que no esten presentes localmente. Al igual que el metodo init()
, devuelve una Promise que se resuelve al terminar la carga.
Callejero.cargarCalles(options).then((res) => {
//Los datos han sido cargados en este punto
})
#####buscarPorCodigo(codigo) Busca una calle a partir de un codigo. Devuelve un arreglo conteniendo las calles encontradas.