Giter VIP home page Giter VIP logo

bitbreakr / roaming Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 682 KB

Roaming is a module that let you get a country informations from a given ISO2 code and to also retrieve a list of countries from a certain given criteria such as the subregion.

License: The Unlicense

TypeScript 100.00%
country country-list country-data country-codes country-information npm npm-package npm-module nodejs

roaming's Introduction

Roaming

Build Status

Roaming is a module that let you get a country informations from a given ISO2 code and to also retrieve a list of countries from a certain given criteria such as the subregion.

Install

yarn add roaming or npm install --save roaming

Import

There are many ways to import the module, here is a list of ways you can import it according your environment and coding style.

// 1.
const roaming = require('roaming');

// 2.
const { get, find } = require('roaming');

// 3.
import * as roaming from 'roaming';

// 4.
import { get, find } from 'roaming';

How to use

.get(countryCode: string)

Returns a country from a given ISO-2 country code

/*
* This should output the country object of country
*  France with all props related to this latter one.
**/

// IIFE example:

(async () => {
	const france = await roaming.get('fr');

	// Outputs related country object
	console.log(france);
});

.find(query: object)

/*
* This should output a list of country objects
* that match the query. Queries of deep nested elements
* are not supported for the moment.
**/

// IIFE example:

async () => {
  const query = { subregion: "Western Europe" };
  const westernEurope = await roaming.find(query);

  // Outputs a list of countries matching the query
  console.log(westernEurope);
};

Some query examples

Get a list of countries by a given region:

/*
* Available regions are:
* - 'Europe'
* - 'Asia'
* - 'Americas'
* - 'Africa'
* - 'Oceania'
* - 'Polar'
** /

const query = { region: "Asia" };
const asianCountries = await roaming.find(query);

Get a list of countries by a given subregion:

/*
* Available subregions are:
* - 'Southern Europe'
* - 'Western Asia'
* - 'Southern Asia'
* - 'Caribbean'
* - 'Middle Africa'
* - 'South America'
* - 'Polynesia'
* - 'Western Europe'
* - 'Australia and New Zealand'
* - 'Northern Europe'
* - 'Western Africa'
* - 'Eastern Europe'
* - 'Eastern Africa'
* - 'Northern America'
* - 'South-Eastern Asia'
* - 'Southern Africa'
* - 'Central America'
* - 'Eastern Asia'
* - 'Northern Africa'
* - 'Melanesia'
* - 'Micronesia'
* - 'Central Asia'
** /

const query = { subregion: "South America" };
const southAmericaCountries = await roaming.find(query);

Queryable elements

Property Description Type Example
Name The country's name string France
alpha2Code The 2 letters ISO code string FR
alpha3Code The 3 letters ISO code string FRA
capital The country's capital string Paris
region The region some countries belong to string Europe
subregion The subregion some countries belong to string Western Europe

roaming's People

Contributors

bitbreakr avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.