Git Product home page Git Product logo

iso-3166-1-ts's Introduction

iso-3166-1-ts

Provides ISO 3166-1 values and types. Country codes are fetched from takuma7/iso-3166-1-csv, which contains up-to-date canonical codes scraped from ISO's website.

Installation

yarn add iso-3166-1-ts

Usage

findBy* methods let you find an ISO 3166-1 record. If not found, they return undefined.

import {
  findByAlpha2,
  findByAlpha3,
  findByNumeric,
} from 'iso-3166-1-ts'

console.log(findByAlpha2('AF'))
console.log(findByAlpha2('af'))
console.log(findByAlpha3('AFG'))
console.log(findByAlpha3('afg'))
console.log(findByNumeric('004'))
console.log(findByNumeric(4))
// All the above will output:
// {
//   alpha2: "AF",
//   alpha3: "AFG",
//   name: "Afghanistan",
//   name_fr: "Afghanistan (l')",
//   numeric: "004",
// }

This package also exports the data so you can play with it as you wish:

import {
  records,
  alpha2Codes,
  alpha3Codes,
  names,
  namesFr,
} from 'iso-3166-1-ts'

alpha2Codes.forEach((code) => {
  // e.g.) Get more information from ISO website
  const url = `https://www.iso.org/obp/ui/#iso:code:3166:${code}`
  // ...
})

You can also use types:

import { Alpha2Code } from 'iso-3166-1-ts'

export interface User {
  name: string
  country: Alpha2Code
}

const u: User = { name: 'foo', country: 'whatever' } // doesn't compile

For more details, please refer to the API reference.

iso-3166-1-ts's People

Contributors

takuma7 avatar

Stargazers

 avatar  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.