SpanishCities 1.5.0

Si te aprendiste las provincias de carrerilla en el colegio y con un horrible ritmo que se te metía en la cabeza, ¡Ya es hora de que las olvides!

Esta librería pone a tu disposición una serie de métodos para poder recuperar todas las provincias españolas y las localidades de cada una de ellas. De esta manera, te será más sencillo generar los selectores para la selección de ciudad en los registros de tus usuarios.

Modo de uso

Instalación

npm install spanishcities

Para poder recuperar todas las provincias españolas:

import { getProvinces } from 'spanishcities'

const provinces = getProvinces();

El resultado de esta acción es un array con las 52 provincias españolas, cada una con el siguiente formato:

[
    ...
    {
        "code": 28,
        "name": "Madrid",
        "alternative": ""
    }
    ...
]

El campo alternative queda reservador para todas aquellas provincias que tengan un nombre alternativo al oficial.

Para poder recuperar las localidades de cada una de las provincias podemos usar el método getCities

import { getCities } from 'spanishcities';

// El primer parámetro hace referencia al código de la provincia
const cities = getCities(28);

// El segundo parámetro es un boolean que nos indica si, junto a la información de las localidades queremos adjuntar la información de la provincia
const citiesWithProvince = getCities(28, false);

Todos los datos de provincias y localidades están sacados del Instituto Nacional de Estadística