Installation

npm install --save @types/country-list

Summary

This package contains type definitions for country-list (https://github.com/fannarsh/country-list).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/country-list.

index.d.ts

1export interface Country {
2    code: string;
3    name: string;
4}
5
6/**
7 * Expects an array of code and country name pairs to add to the list. Doesn't return anything.
8 */
9export function overwrite(countries: Country[]): void;
10
11/**
12 * Expects a two-digit country code. Returns the name for that country. If not found, it returns undefined.
13 */
14export function getName(code: string): string | undefined;
15
16/**
17 * Expects the English country name. Returns the code for that country. If not found, it returns undefined.
18 */
19export function getCode(name: string): string | undefined;
20
21/**
22 * Returns an array of all country names.
23 */
24export function getNames(): string[];
25
26/**
27 * Returns an array of all country codes.
28 */
29export function getCodes(): string[];
30
31/**
32 * Returns a key-value object of all countries using the name as key.
33 */
34export function getNameList(): { [name: string]: string };
35
36/**
37 * Returns a key-value object of all countries using the code as key.
38 */
39export function getCodeList(): { [code: string]: string };
40
41/**
42 * Returns an array of all country information, in the same format as it gets imported.
43 */
44export function getData(): Country[];
45

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Kyle Roach, and Adam Binford.