Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.02 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.02 KB

REST Countries

This library is a wrapper for the REST Countries API (v3.1) to access information about 250 countries around the world easily and is written in TypeScript to ensure type safety and provide a better developer experience.

Links

Installation

npm i rest-countries

yarn add rest-countries

pnpm add rest-countries

bun add rest-countries

Example

import { getAll, searchByName } from 'rest-countries';

// Fetch all the countries
const countries = await getAll();

// Fetch all the countries with filtered fields (this will make the request faster)
const countries = await getAll(['name', 'capital', 'population']);

// Search amoung countries by their name
const countries = await searchByName('Vietnam');