countries-and-nationalities v1.0.1

Install using npm install countries-and-nationalities

The package is designed to be quick and easy to use. It contains two (2) simple functions:

1. getListofNationalities(arrayOfNationalitiesToIncludeAtTheTop)

This returns an array of the most commonly used nationalities, sorted in alphabetical order. It simply return an array of strings of nationalities.

Sample snippet of the response:

"Afghan", "Albanian", "Algerian", ...

The arrayOfNationalitiesToIncludeAtTheTop argument The arrayOfNationalitiesToIncludeAtTheTop argument is intended to be used to specify the most common nationalities of users of your application. For example, if 90% of your users are from Zambia or Zimbabwe, it would be a poor user experience to have them scroll to the bottom of the list to find their nationality. Instead, pass in "Zambian", "Zimbabwean" to the getListofNationalities function and those two nationalities will be placed at the top of the array returned by the function. Ensure the nationalities are spelt correctly.

Sample snippet of the result would be:

"Zambian", "Zimbabwean" "Afghan", "Albanian", "Algerian", ...

Note: incorrectly spelt nationalities will be ignored. Omit this argument to get the nationalities in alphabetical order.

2. getListOfCountries(arrayOfCountriesToIncludeAtTheTop) This returns an array of the most commonly used countries, in alphabetical order. These simply return an array of strings of countries.

Snippet of the response:

const countries = "Afghanistan", "Albania", "Algeria", "American Samoa", ...

The arrayOfCountriesToIncludeAtTheTop argument The arrayOfCountriesToIncludeAtTheTop argument is intended to be used to specify the most common countries of users of your application. For example, if 90% of your users are from Zambia or Zimbabwe, it would be a poor user experience to have them scroll to the bottom of the list to find their country. Instead, pass in "Zambia", "Zimbabwe" to the getListOfCountries function and those two countries will be placed at the top of the array returned by the function. Ensure the countries are spelt correctly.

Sample snippet of the result would be:

"Zambia", "Zimbabwe" "Afghan", "Albanian", "Algerian", ...

Note: incorrectly spelt countries will be ignored. Omit this argument to get the countries in alphabetical order.