Skip to content

Commit aca4066

Browse files
committed
change key name and update params description
1 parent 530854b commit aca4066

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

src/ipinfoWrapper.ts

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,19 @@ export default class IPinfoWrapper {
4848
* then LruCache is used as default.
4949
* @param timeout Timeout in milliseconds that controls the timeout of requests.
5050
* It defaults to 5000 i.e. 5 seconds. A timeout of 0 disables the timeout feature.
51-
* @param countries An optional parameter representing custom countries data.
52-
* If not provided, default countries data will be used.
53-
* @param countriesFlags An optional parameter representing custom countries flags data.
54-
* If not provided, default countries flags data will be used.
55-
* @param countriesCurrencies An optional parameter representing custom countries currencies data.
56-
* If not provided, default countries currencies data will be used.
57-
* @param continents An optional parameter representing custom continents data.
58-
* If not provided, default continents data will be used.
59-
* @param euCountries An optional parameter representing custom EU countries data.
60-
* If not provided or an empty array, default EU countries data will be used.
51+
* @param i18nData Internationalization data for customizing countries-related information.
52+
* @param i18nData.countries Custom countries data. If not provided, default countries data will be used.
53+
* @param i18nData.countriesFlags Custom countries flags data. If not provided, default countries flags data will be used.
54+
* @param i18nData.countriesCurrencies Custom countries currencies data. If not provided, default countries currencies data will be used.
55+
* @param i18nData.continents Custom continents data. If not provided, default continents data will be used.
56+
* @param i18nData.euCountries Custom EU countries data. If not provided or an empty array, default EU countries data will be used.
57+
6158
*/
6259
constructor(
6360
token: string,
6461
cache?: Cache,
6562
timeout?: number,
66-
customData?: {
63+
i18nData?: {
6764
countries?: any,
6865
countriesFlags?: any,
6966
countriesCurrencies?: any,
@@ -72,13 +69,13 @@ export default class IPinfoWrapper {
7269
}
7370
) {
7471
this.token = token;
75-
this.countries = customData?.countries ? customData.countries : defaultCountries;
76-
this.countriesFlags = customData?.countriesFlags ? customData.countriesFlags: defaultCountriesFlags;
77-
this.countriesCurrencies = customData?.countriesCurrencies ? customData.countriesCurrencies: defaultCountriesCurrencies;
78-
this.continents = customData?.continents ? customData.continents : defaultContinents;
72+
this.countries = i18nData?.countries ? i18nData.countries : defaultCountries;
73+
this.countriesFlags = i18nData?.countriesFlags ? i18nData.countriesFlags: defaultCountriesFlags;
74+
this.countriesCurrencies = i18nData?.countriesCurrencies ? i18nData.countriesCurrencies: defaultCountriesCurrencies;
75+
this.continents = i18nData?.continents ? i18nData.continents : defaultContinents;
7976
this.euCountries =
80-
customData?.euCountries && customData?.euCountries.length !== 0
81-
? customData.euCountries : defaultEuCountries;
77+
i18nData?.euCountries && i18nData?.euCountries.length !== 0
78+
? i18nData.euCountries : defaultEuCountries;
8279
this.cache = cache ? cache : new LruCache();
8380
this.timeout =
8481
timeout === null || timeout === undefined

0 commit comments

Comments
 (0)