Библиотека Country Information

Эта библиотека предоставляет функции для получения информации о странах на основе различных входных данных, таких как коды стран, названия, флаги и телефонные номера.

Установка

npm install opex-countrycode

Использование

const { getCountryInformation, getInfoByIOC, getInfoByISO2, getInfoByISO3, getInfoByName, getInfoByFlag, getInfoByPhone } = require('country-information-library');

Основные функции

getCountryInformation(input, isIOC = false)

Основная функция для получения информации о стране. Она автоматически определяет тип входных данных и возвращает соответствующую информацию.

Параметры:

• input (string): Код страны (ISO2, ISO3), название страны, эмодзи флага или телефонный номер.
• isIOC (boolean, по умолчанию false): Указывает, является ли входное значение кодом IOC.

Возвращает:

Объект с информацией о стране или undefined, если информация не найдена.

Пример:

const countryInfo = getCountryInformation('US');
console.log(countryInfo);

getInfoByIOC(code)

Получает информацию о стране по коду IOC.

Параметры:

• code (string): Код IOC страны.

Возвращает:

Объект с информацией о стране или undefined, если информация не найдена.

getInfoByISO2(code)

Получает информацию о стране по коду ISO2.

Параметры:

• code (string): Код ISO2 страны.

Возвращает:

Объект с информацией о стране или undefined, если информация не найдена.

getInfoByISO3(code)

Получает информацию о стране по коду ISO3.

Параметры:

• code (string): Код ISO3 страны.

Возвращает:

Объект с информацией о стране или undefined, если информация не найдена.

getInfoByName(name)

Получает информацию о стране по её названию.

Параметры:

• name (string): Название страны.

Возвращает:

Объект с информацией о стране или undefined, если информация не найдена.

getInfoByFlag(flag)

Получает информацию о стране по эмодзи флага.

Параметры:

• flag (string): Эмодзи флага страны.

Возвращает:

Объект с информацией о стране или undefined, если информация не найдена.

getInfoByPhone(phoneNumber)

Получает информацию о стране по телефонному номеру.

Параметры:

• phoneNumber (string): Телефонный номер.

Возвращает:

Объект с информацией о стране (включая данные о телефоне) или undefined, если информация не найдена.

Формат возвращаемых данных

Все функции возвращают объект со следующей структурой (если информация найдена):

{
  ISO2: string,      // Код страны ISO2
  ISO3: string,      // Код страны ISO3
  IOC: string,       // Код страны IOC
  FIFA: string,      // Код страны FIFA
  name: string,      // Краткое название страны
  fullName: string,  // Полное название страны
  unicode: string,   // Юникод флага
  emoji: string,     // Эмодзи флага
  dialCode: string,  // Телефонный код страны
  phone?: {          // Информация о телефоне (только для getInfoByPhone)
    isValid: boolean,
    number: string,
    countryCode: string
  }
}

Примечания

• Функции нечувствительны к регистру входных данных.
• Если информация не найдена, функции возвращают undefined.
• При использовании getInfoByPhone, дополнительно возвращается информация о телефоне.

Создатель

OpexDev