Code Monkey home page Code Monkey logo

un-m49's Introduction

un-m49

Build Coverage Downloads Size

Info on UN M49.

Contents

What is this?

This package contains info on UN M49 (Standard Country or Area Codes for Statistical Use). UN M49 is similar to ISO 3166 (the GB in en-GB). The difference is that ISO 3166 uses alphabetical codes based on how a region is called by a group of people, whereas UN M49 uses numerical codes. Numerical codes are useful because they are resistant to changes and geopolitical conflicts. UN M49 also contains regions bigger than countries, such as (sub)continents. That’s useful for example for es-419 to describe Spanish as used in Latin America and the Caribbean.

When should I use this?

You can use this package any time you have to deal with regions or UN M49 in particular.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install un-m49

In Deno with esm.sh:

import {unM49, toIso3166} from 'https://esm.sh/un-m49@2'

In browsers with esm.sh:

<script type="module">
  import {unM49, toIso3166} from 'https://esm.sh/un-m49@2?bundle'
</script>

Use

import {unM49} from 'un-m49'

console.log(unM49.slice(0, 20))

Yields:

[
  {type: 0, name: 'World', code: '001'},
  {type: 1, name: 'Africa', code: '002', parent: '001'},
  {type: 4, name: 'Afghanistan', code: '004', iso3166: 'AFG', parent: '034'},
  {type: 3, name: 'South America', code: '005', parent: '419'},
  {type: 4, name: 'Albania', code: '008', iso3166: 'ALB', parent: '039'},
  {type: 1, name: 'Oceania', code: '009', parent: '001'},
  {type: 4, name: 'Antarctica', code: '010', iso3166: 'ATA', parent: '001'},
  {type: 3, name: 'Western Africa', code: '011', parent: '202'},
  {type: 4, name: 'Algeria', code: '012', iso3166: 'DZA', parent: '015'},
  {type: 3, name: 'Central America', code: '013', parent: '419'},
  {type: 3, name: 'Eastern Africa', code: '014', parent: '202'},
  {type: 2, name: 'Northern Africa', code: '015', parent: '002'},
  {type: 4, name: 'American Samoa', code: '016', iso3166: 'ASM', parent: '061'},
  {type: 3, name: 'Middle Africa', code: '017', parent: '202'},
  {type: 3, name: 'Southern Africa', code: '018', parent: '202'},
  {type: 1, name: 'Americas', code: '019', parent: '001'},
  {type: 4, name: 'Andorra', code: '020', iso3166: 'AND', parent: '039'},
  {type: 2, name: 'Northern America', code: '021', parent: '019'},
  {type: 4, name: 'Angola', code: '024', iso3166: 'AGO', parent: '017'},
  {type: 4, name: 'Antigua and Barbuda', code: '028', iso3166: 'ATG', parent: '029'}
]

API

This package exports the identifiers unM49 and toIso3166. There is no default export.

unM49

List of Regions (Array<Region>).

Region

Object with the following properties:

  • type (Type) — Type (example: 4)
  • name (string) — name (example: 'United Kingdom of Great Britain and Northern Ireland')
  • code (string) — three-character UN M49 code (example: 826)
  • iso3166 (string?) — ISO 3166-1 alpha-3 code, if type represents a country or area (example: 'GBR')
  • parent (string?) — code of parent region, if type does not represent the planet (example: '154')

Type

number, one of the following:

  • 0 — global (example: 001 World)
  • 1 — region (example: 002 Africa)
  • 2 — subregion (example: 202 Sub-Saharan Africa)
  • 3 — intermediate region (example: 017 Middle Africa)
  • 4 — country or area (example: 024 Angola)

👉 Note: Regions can be “missing” between a region and its parent. For example, the parent of the “country or area” (4) 010 Antarctica is 001 World (4). Intermediate regions (3) aren’t used a lot.

toIso3166

Map of UN M49 codes to ISO 3166-1 alpha-3 codes (Record<string, string>).

Types

This package is fully typed with TypeScript. It exports the additional types Type and UNM49.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

un-m49's People

Contributors

wooorm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

un-m49's Issues

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.