country-notes

Utility to fetch country codes viz ISO2, ISO3 and Phone code of all the countries listed in http://countrycode.org/.

Exposes the below APIs:

• Pass in any of the CountryName,PhoneCode,ISO2/ISO3 country code to get other details of the country.
• Get Name of country.
• Get ISO2 country code.
• Get ISO3 country code.
• Get Phone code of country.

Installation

pnpm i country-notes
# or
npm i country-notes
# or
yarn add country-notes

Examples

With ESM

import {
  getAll,
  getTotal,
  findByName,
  excludeByNames,
  findByCode,
  filterByCodes,
  excludeByCodes,
  findByPhoneCode,
  excludeByPhoneCodes
} from 'country-notes'

// or
// import * as CountryNotes from 'country-notes'

getAll() // Returns an array of country information
getTotal() // Return total number of countries
findByName('China') // Return country information by name
excludeByNames(['China', 'India']) // Returns an array of country information by excluding names
findByCode('CN') // Return country information by ISO2/ISO3 Code
filterByCodes(['CN', 'IND']) // Returns an array of country information by ISO2/ISO3 Codes
excludeByCodes(['CN', 'IND']) // Returns an array of country information by excluding ISO2/ISO3 Codes
findByPhoneCode('86') // Return country information by Phone Code
excludeByPhoneCodes(['86', '91']) // Returns an array of country information by excluding Phone Codes

With CommonJS

const {
  getAll,
  getTotal,
  findByName,
  excludeByNames,
  findByCode,
  filterByCodes,
  excludeByCodes,
  findByPhoneCode,
  excludeByPhoneCodes
} = require('country-notes')
// or
// const CountryNotes = require('country-notes')

getAll() // Returns an array of country information
getTotal() // Return total number of countries
findByName('China') // Return country information by name
excludeByNames(['China', 'India']) // Returns an array of country information by excluding names
findByCode('CN') // Return country information by ISO2/ISO3 Code
filterByCodes(['CN', 'IND']) // Returns an array of country information by ISO2/ISO3 Codes
excludeByCodes(['CN', 'IND']) // Returns an array of country information by excluding ISO2/ISO3 Codes
findByPhoneCode('86') // Return country information by Phone Code
excludeByPhoneCodes(['86', '91']) // Returns an array of country information by excluding Phone Codes

Contributing

• Sending a pull request: Pull requests
• Reporting Issues: Issues

License

MIT