https://github.com/nozzlegear/typed-countries
An array of the world's countries, complete with full TypeScript declaration support.
https://github.com/nozzlegear/typed-countries
Last synced: 5 days ago
JSON representation
An array of the world's countries, complete with full TypeScript declaration support.
- Host: GitHub
- URL: https://github.com/nozzlegear/typed-countries
- Owner: nozzlegear
- License: mit
- Created: 2016-12-02T17:20:31.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T15:06:41.000Z (almost 5 years ago)
- Last Synced: 2025-03-27T20:11:59.075Z (7 months ago)
- Language: TypeScript
- Size: 21.5 KB
- Stars: 14
- Watchers: 2
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typed-countries
An array of the world's countries, complete with full TypeScript declaration support.
## Installation
Install from the NPM registry with NPM itself, or with [Yarn](https://github.com/yarnpkg/yarn):
```sh
# NPM:
npm install typed-countries
# or Yarn:
yarn add typed-countries
```
## Importing
You can import the package with ES6-style imports, or through Node's require:
```js
//ES6-style import
import { countries, regions } from "typed-countries";
//Require
const countries = require("typed-countries").countries;
const regions = require("typed-countries").regions;
```
This package also uses an ES6-style default export:
```js
//ES6-style default import
import countries from "typed-countries";
//Require
const countries = require("typed-countries").default;
```
## Usage
The export is an array of country objects, which means you can use all of the usual array operations on the country list:
```js
import { countries } from "typed-countries";
const usa = countries.find(c => c.iso === "US");
console.log(usa);
// {
// iso: 'US',
// name: 'United States',
// hasPostalCodes: true,
// region: "Americas",
// states: [
// {
// iso: 'AL',
// name: 'Alabama'
// },
// ...
// ],
// zipRegex: "^\\d{5}([\\-]\\d{4})?$"
// }
```
This package also contains an simple string array of all 6 regions used in the countries array.
```js
import { regions } from "typed-countries";
console.log(regions);
// [ "Asia", "Europe", "Africa", "Oceania", "Americas", "Antarctica" ]
```
## TypeScript
If you're using TypeScript, you can easily import the Country, Region and State interfaces:
```js
import { countries, Country, State, Region } from "typed-countries";
const usa: Country = countries.find(c => c.iso === "US");
const iowa: State = usa.states.find(c => c.iso === "IA");
const region: Region = usa.region; // "Americas"
```