country-codes-list 1.6.11 → 1.6.12

package/README.md

@@ -1,4 +1,5 @@
 # country-codes-list
+
 Module with list of codes per country, which includes:
 
 - Country code (ISO 3166-1 alpha-2): Obtained from [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
@@ -9,12 +10,13 @@ Module with list of codes per country, which includes:
 - TIN Name: Obtained from [Wikipedia](https://en.wikipedia.org/wiki/VAT_identification_number)
 - Official language code (usually from ISO 639-1, or ISO 639-3 otherwise)): Obtained from [Open Street Map](https://wiki.openstreetmap.org/wiki/Nominatim/Country_Codes). Returns only the first official language code per country
 - Official language name: Each name in english and in the local country language
-- Country Calling Code: The phone calling code for the country. Obtained from [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes#Alphabetical_listing_by_country_or_region). 
+- Country Calling Code: The phone calling code for the country. Obtained from [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes#Alphabetical_listing_by_country_or_region).
 - Region: The Regional Classifications are from the [International Telecommunications Union](http://www.itu.int/ITU-D/ict/definitions/regions/index.html). Seen [here](https://meta.wikimedia.org/wiki/List_of_countries_by_regional_classification)
 
-
 # Installation
+
 ## Install the NPM module
+
 ```bash
     npm install --save country-codes-list
 ```
@@ -23,9 +25,10 @@ Module with list of codes per country, which includes:
 
 ### customList method:
 
-Just import the module and call the customList method. The first parameter must be the key you want for your object, and the second parameter must be a string with placeholders written as you need. The placeholders are defined between brackets (`{placeholder}`). 
+Just import the module and call the customList method. The first parameter must be the key you want for your object, and the second parameter must be a string with placeholders written as you need. The placeholders are defined between brackets (`{placeholder}`).
+
+The possible values for the object key and the placeholders are:
 
-The possible values for the object key and the placeholders are: 
 - countryNameEn
 - countryNameLocal
 - countryCode
@@ -43,12 +46,15 @@ The possible values for the object key and the placeholders are:
 #### Example
 
 ```js
-const countryCodes = require('country-codes-list')
+const countryCodes = require("country-codes-list");
 
-const myCountryCodesObject = countryCodes.customList('countryCode', '[{countryCode}] {countryNameEn}: +{countryCallingCode}')
+const myCountryCodesObject = countryCodes.customList(
+  "countryCode",
+  "[{countryCode}] {countryNameEn}: +{countryCallingCode}"
+);
 ```
 
-This will return an object like this one: 
+This will return an object like this one:
 
 ```js
 {
@@ -69,4 +75,4 @@ This will return an object like this one:
     ...
 }
 
-```
+```

package/index.d.ts

@@ -2,38 +2,25 @@
 // by jakeisnt, Feb. 2022
 
 declare module 'country-codes-list' {
-  export enum CountryProperty {
-    countryNameEn = 'countryNameEn',
-    countryNameLocal = 'countryNameLocal',
-    countryCode = 'countryCode',
-    currencyCode = 'currencyCode',
-    currencyNameEn = 'currencyNameEn',
-    tinType = 'tinType',
-    tinName = 'tinName',
-    officialLanguageCode = 'officialLanguageCode',
-    officialLanguageNameEn = 'officialLanguageNameEn',
-    officialLanguageNameLocal = 'officialLanguageNameLocal',
-    countryCallingCode = 'countryCallingCode',
-    region = 'region',
-    flag = 'flag',
-  }
 
-  type CountryData = {
-    [CountryProperty.countryNameEn]: string
-    [CountryProperty.countryNameLocal]: string
-    [CountryProperty.countryCode]: string
-    [CountryProperty.currencyCode]: string
-    [CountryProperty.currencyNameEn]: string
-    [CountryProperty.tinType]: string
-    [CountryProperty.tinName]: string
-    [CountryProperty.officialLanguageCode]: string
-    [CountryProperty.officialLanguageNameEn]: string
-    [CountryProperty.officialLanguageNameLocal]: string
-    [CountryProperty.countryCallingCode]: string
-    [CountryProperty.region]: string
-    [CountryProperty.flag]: string
+  export type CountryData = {
+    countryNameEn: string
+    countryNameLocal: string
+    countryCode: string
+    currencyCode: string
+    currencyNameEn: string
+    tinType: string
+    tinName: string
+    officialLanguageCode: string
+    officialLanguageNameEn: string
+    officialLanguageNameLocal: string
+    countryCallingCode: string
+    region: string
+    flag: string
   }
 
+  export type CountryProperty = keyof CountryData
+
   type Filter<T> = (element: T, index: number, array: T[]) => T[]
 
   type CustomArraySettings = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "country-codes-list",
-  "version": "1.6.11",
+  "version": "1.6.12",
   "description": "List of codes per country (languages, calling codes, currency codes, etc)",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -34,4 +34,4 @@
     "url": "https://github.com/LucianoGanga/country-codes/issues"
   },
   "homepage": "https://github.com/LucianoGanga/country-codes#readme"
-}
+}