Get the country name in Spanish for any ISO 3166-1 alpha-2 country code, and vice versa.
The full list of 263 country names and codes in this package is composed as follows:
- 249 officially assigned code elements.
- 13 exceptionally reserved code elements.
- 1 extra code element added for functionallity.
As with any other node package:
npm install country-list-spanish
The package exports four functions:
Arguments: 1, string
, an ISO 3166-1 alpha-2 code.
Returns: string
, a country name in Spanish.
If the code parameter is left empty or it's not in the list, returns undefined
.
const { getCountry } = require("country-list-spanish");
console.log(getCountry("PM")); // logs 'San Pedro y Miquelón'
console.log(getCountry("IC")); // logs 'Islas Canarias'
console.log(getCountry("NJ")); // logs undefined
Arguments: 1, string
, a country name in Spanish.
Returns: string
, an ISO 3166-1 alpha-2 code.
If the country parameter is left empty or it's not in the list, returns undefined
.
const { getCode } = require("country-list-spanish");
console.log(getCode("San Pedro y Miquelón")); // logs 'PM'
console.log(getCode("Islas Canarias")); // logs 'IC'
console.log(getCode("País de Nunca Jamás")); // logs undefined
Arguments: 0 or 1, object
, a config object (see table below and examples).
Returns: array
(default) or object
, with all the countries in the list.
By default, the function returns an array with all 249 official country names in it.
If { object: true }
is passed as config, the function returns an object of code-country (key-value) pairs.
If { extended: true }
is passed, the exceptionally reserved codes are included in the response.
const { getCountries } = require("country-list-spanish");
console.log(getCountries()); // logs [ "Andorra", "Emiratos Árabes Unidos", ... ], an array of length 249
console.log(getCountries({ object: true, extended: true })); // logs { AD: "Andorra", AE: "Emiratos Árabes Unidos", ... }, an object with 263 key-value pairs
Arguments: 0 or 1, object
, a config object (see below).
Returns: array
(default) or object
, with all the codes in the list.
By default, the function returns an array with all 249 official codes in it.
If {object: true}
is passed as config, the function returns an object of country-code (key-value) pairs.
If {extended: true}
is passed, the exceptionally reserved codes are included in the response.
const { getCodes } = require("country-list-spanish");
console.log(getCodes()); // logs [ "AD", "AE", ... ], an array of length 249
console.log(getCodes({ object: true })); // logs { Andorra: "AD", Emiratos Árabes Unidos: "AE", ... }, an object with 249 key-value pairs
param | type | default | feature |
---|---|---|---|
object | boolean |
false | Return an array or an object |
extended | boolean |
false | Include the 14 reserved/extra codes or not |