feat: Support short number handling

closes #112
grantila · Aug 25, 2024 · df36157 · df36157
1 parent 84ee203
commit df36157
Show file tree

Hide file tree

Showing 6 changed files with 479 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -78,6 +78,8 @@ const pn = {
 	possibility: 'is-possible',
 	regionCode: 'SE',
 	possible: true,
+	shortPossible: false,
+	shortValid: false,
 	canBeInternationallyDialled: true,
 	type: 'mobile',
 	countryCode: 46,
@@ -105,6 +107,8 @@ interface ParsedPhoneNumberValid {
 	possibility: PhoneNumberPossibility; // a string union, see below
 	regionCode: string;
 	possible: boolean;
+	shortPossible: boolean;
+	shortValid: boolean;
 	canBeInternationallyDialled: boolean;
 	type: PhoneNumberTypes; // a string union, see below
 	countryCode: number;
@@ -121,10 +125,14 @@ interface ParsedPhoneNumberInvalid {
 
 	possible: false;
 	possibility: 'invalid';
+	shortPossible: boolean;
+	shortValid: boolean;
 	error?: unknown;
 };
 ```
 
+Note that an incorrect (invalid) phone number can still be a valid _short number_ for the given region.
+
 
 ## API