add numeric code types, make types more precise, add some types tests #259

osdiab · 2021-09-29T07:21:43Z

Supercedes #198 , closes #184

The tests may look wacky but included a couple comments at the top to explain how it works.

Also npm test fails right now with this:

Oops! Something went wrong! :(

ESLint: 7.32.0

Error: Cannot find module '@eslint/eslintrc'
Require stack:
- /Users/omar/code/open-source/node-i18n-iso-countries/node_modules/eslint/lib/cli-engine/cli-engine.js
- /Users/omar/code/open-source/node-i18n-iso-countries/node_modules/eslint/lib/eslint/eslint.js
- /Users/omar/code/open-source/node-i18n-iso-countries/node_modules/eslint/lib/eslint/index.js
- /Users/omar/code/open-source/node-i18n-iso-countries/node_modules/eslint/lib/cli.js
- /Users/omar/code/open-source/node-i18n-iso-countries/node_modules/eslint/bin/eslint.js
    at Function.Module._resolveFilename (node:internal/modules/cjs/loader:941:15)
    at Function.Module._load (node:internal/modules/cjs/loader:774:27)
    at Module.require (node:internal/modules/cjs/loader:1013:19)
    at require (/Users/omar/code/open-source/node-i18n-iso-countries/node_modules/v8-compile-cache/v8-compile-cache.js:159:20)
    at Object.<anonymous> (/Users/omar/code/open-source/node-i18n-iso-countries/node_modules/eslint/lib/cli-engine/cli-engine.js:33:5)
    at Module._compile (/Users/omar/code/open-source/node-i18n-iso-countries/node_modules/v8-compile-cache/v8-compile-cache.js:192:30)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1138:10)
    at Module.load (node:internal/modules/cjs/loader:989:32)
    at Function.Module._load (node:internal/modules/cjs/loader:829:14)
    at Module.require (node:internal/modules/cjs/loader:1013:19)
make: *** [eslint] Error 2

osdiab · 2021-09-29T07:22:12Z

index.d.ts


+export type StringNumericCode =


pulled these numbers from wikipedia

osdiab · 2021-09-29T07:25:40Z

tsconfig.json

+{
+  "compilerOptions": {
+    "strict": true,
+    "noEmit": true


This keeps it from actually emitting any code

osdiab · 2021-09-29T07:26:10Z

tsconfig.json

+    "strict": true,
+    "noEmit": true
+  },
+  "include": ["test/**/*.ts"],


This tells TypeScript to specifically try to compile the test files, and fails if the test files contain type errors

osdiab · 2021-09-29T07:26:35Z

index.d.ts

@@ -15,55 +13,53 @@ export type LocaleData = {
  }
 };

+type Normalize<Input extends string | number> = Input extends string ? Lowercase<Input> : Input;


Normalization is necessary since the library can actually accept any case of codes, like UsA or usa

osdiab · 2021-09-29T07:27:02Z

index.d.ts

-export function alpha3ToNumeric(alpha3: string | Alpha3Code): string;
-export function numericToAlpha2(numeric: number | string): string;
-export function numericToAlpha3(numeric: number | string): string;
+export function alpha2ToAlpha3<Input extends string>(alpha2: Input): Normalize<Input> extends Normalize<Alpha2Code> ? Alpha3Code : Alpha3Code | undefined;


But it always returns the upper-cased ones, so we dont normalize the return values

osdiab · 2021-09-29T07:27:40Z

index.d.ts


 /**
 * @param countryCode  Alpha2 or Alpha3 or Numeric
 * @param lang        ISO 639-1 format string
 */
-export function getName(
-  countryCode: string | number | Alpha2Code | Alpha3Code,


These kinds of types are redundant, since string and number already subsume Alpha2Code, Alpha3Code, and NumericCode

osdiab · 2021-09-29T07:28:50Z

index.d.ts

-  countryCode: string | number | Alpha2Code | Alpha3Code,
-  lang: string
-): string;
+export function getName(countryCode: string | number, lang: string): string | undefined;


We can't have a more specific type here since A) the name of the country varies arbitrarily by language; and B) if the language is bad, then it'll return undefined; I think it's a bad idea to try to add all the possible language codes, it's overkill.

osdiab · 2021-09-29T07:30:12Z

index.d.ts


 /**
 * @param lang    ISO 639-1 format string
 */
-export function getNames(lang: string): LocalizedCountryNames<{ select: 'official' }>;
+export function getNames(lang: string): LocalizedCountryNames<{ select: 'official' }> | {};


Like in the other PR, I personally don't mind it having the {} empty object type. Ideally the API would have chosen something more explicit like null as the return type since it's easier to work with and way more explicit, but it's too late for that.

osdiab · 2021-09-29T07:30:59Z

test/typings-test.ts

@@ -0,0 +1,128 @@
+import { alpha2ToAlpha3, alpha2ToNumeric, alpha3ToAlpha2, alpha3ToNumeric, toAlpha2, toAlpha3 } from "..";


The goal with these tests are to just make a program that doesn't contain type errors, but ensures that inference is happening properly when using the library functions.

michaelwittig · 2023-04-12T15:35:55Z

This PR seems to be quiet complicated. I'm preferring #319 for simplicity. Please reopen and explain me why this is better )I'm not using TypeScript).

osdiab · 2023-04-13T02:00:00Z

i just stopped using this library since its types are bad, this PR was from a year and a half ago so I'm not fresh on the details, but based on rereading it, it basically made the returned and requested types much more precise and matching the intent of the documentation. The other one basically seems to pave over one inconsistency, but otherwise leaves it as is, which is an improvement for sure. But yeah, since i've given up on this library, and it isn't a priority for this library to have precise types, I don't plan to reopen this.

osdiab added 11 commits September 29, 2021 16:13

add numeric code types, make types more precise

945b3ce

add tsconfig for tests

6b6791b

Add typings test

6fea90f

dont emit

0934e74

add typescript dependency

fb304d9

npm install

a171705

typecheck command

bb574d0

further configure typescript

e411f73

Fix bad type and normalize inputs

d924aa3

typings test

9e8b971

Remove erroneous compiled typings test

62dba93

osdiab commented Sep 29, 2021

View reviewed changes

index.d.ts

export type StringNumericCode =

Copy link

Author

osdiab Sep 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pulled these numbers from wikipedia

osdiab commented Sep 29, 2021

View reviewed changes

tsconfig.json

{

"compilerOptions": {

"strict": true,

"noEmit": true

Copy link

Author

osdiab Sep 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This keeps it from actually emitting any code

osdiab commented Sep 29, 2021

View reviewed changes

michaelwittig mentioned this pull request Apr 12, 2023

Update typings for functions returning undefined #198

Closed

michaelwittig closed this Apr 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add numeric code types, make types more precise, add some types tests #259

add numeric code types, make types more precise, add some types tests #259

osdiab commented Sep 29, 2021 •

edited

Loading

osdiab Sep 29, 2021

osdiab Sep 29, 2021

osdiab Sep 29, 2021

osdiab Sep 29, 2021 •

edited

Loading

osdiab Sep 29, 2021

osdiab Sep 29, 2021

osdiab Sep 29, 2021

osdiab Sep 29, 2021

osdiab Sep 29, 2021 •

edited

Loading

michaelwittig commented Apr 12, 2023

osdiab commented Apr 13, 2023

		@@ -0,0 +1,128 @@
		import { alpha2ToAlpha3, alpha2ToNumeric, alpha3ToAlpha2, alpha3ToNumeric, toAlpha2, toAlpha3 } from "..";

add numeric code types, make types more precise, add some types tests #259

add numeric code types, make types more precise, add some types tests #259

Conversation

osdiab commented Sep 29, 2021 • edited Loading

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021 • edited Loading

Choose a reason for hiding this comment

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021

Choose a reason for hiding this comment

osdiab Sep 29, 2021 • edited Loading

Choose a reason for hiding this comment

michaelwittig commented Apr 12, 2023

osdiab commented Apr 13, 2023

osdiab commented Sep 29, 2021 •

edited

Loading

osdiab Sep 29, 2021 •

edited

Loading

osdiab Sep 29, 2021 •

edited

Loading