@brmorillo/global-locations

Library for accessing global location data such as countries, states, and cities.

Installation

npm install @brmorillo/global-locations

Usage

import { GlobalLocations } from '@brmorillo/global-locations';

// Get all countries
const countries = GlobalLocations.Countries.getAllCountries();

// Get a specific country by ID
const brazil = GlobalLocations.Countries.getCountryBy({
  property: 'id',
  value: 'BR',
  selectStates: true
});

// Get states of a country
const brazilStates = GlobalLocations.Countries.getStatesByCountryId('BR');

// Get cities of a state
const saoPauloCities = GlobalLocations.Countries.getCitiesByStateId({
  countryId: 'BR',
  stateId: '35'
});

API

Countries

• getAllCountriesAndData(): Returns all countries with complete data
• getAllCountries(): Returns all countries without state data
• getCountryBy({ property, value, selectStates }): Returns a specific country
• getAllStates(): Returns all states from all countries
• getStatesByCountryId(countryId): Returns states of a specific country
• getStateByParams({ countryId, params }): Searches for a specific state
• isStateInCountry({ countryId, stateId }): Checks if a state belongs to a country
• getAllCities({ countryId }): Returns all cities of a country
• getCitiesByStateId({ countryId, stateId }): Returns cities of a specific state
• getCitiesByParams({ countryId, stateId, params }): Searches for a specific city

License

MIT