My first npm package

#webdev #javascript #opensource

Recently, I was looking for an API that provided country and city data, but I couldn't find anything that fit the bill. Some APIs had country info but left out the cities, while others were just way too expensive, like Google Places.

The requirements for the country were the name, flag, and country code, and for the city, it was just the name and country.

Then, I found two projects that had exactly what I was looking for:

Cities.json: A super cool GitHub repo with a massive list of cities in a handy JSON format.
Restcountries API: A detailed country data.

Merging Data: The Birth of `[@rrrm/countries](https://www.npmjs.com/package/@rrrm/countries)`

To create a unified solution, I merged data from Cities.json and the Restcountries API. The result is the @rrrm/countries NPM package, named after my initials and the focus of the package.

Key Features of @rrrm/countries

Country and City Information: Access to a wealth of data on countries and cities worldwide.
User-Friendly Integration: An NPM package that simplifies integration into your projects.

Usage


import { findCities, findCountry, getAllCitiesByCountry } from "@rrrm/countries"

// find cities with country information
const lisbon = findCities("lisbon", { withCountry: true })
console.log("findCities-> ", lisbon)

// find a country with all cities
const pt = findCountry("PT", { withCity: true })
console.log("findCountry-> ", pt)

// get all cities for  a country
const citiesBycountry = getAllCitiesByCountry("PT")
console.log("getAllCitiesByCountry-> ", citiesBycountry)

Check out the repository here https://github.com/rafaelmagalhaes/countries

Data Files

I have also created two helper functions to convert the results to JSON or CSV:

convertJson(fileName: string, data: any | Country[] | City[]): Convert data to JSON format and save it to a file.
convertCSV(fileName: string, data: any | Country[] | City[]): Convert data to CSV format and save it to a file.

import { convertJson, convertCSV } from './convert.ts';

const data = [{ /* Your data here */ }];
convertJson('data.json', data);
convertCSV('data.csv', data);