angular-phone-helper

v1.1.2

Published

2 years ago

Useful tool for piping and detecting phone format - 188 countries + International format

188 countries + International format (Angular 17)

User's phone's format for pipe

{{ '31234567890' | phoneFormat }} <!-- +3 123 456 7890 -->
{{ '1234567890' | phoneFormat: { iso: 'USA', prefix: true } }} // <!-- +1 (123) 456-7890 -->
{{ '41234567890' | phoneFormat: { prefix: true } }} // <!-- +4 123 456 7890 -->
{{ '1234567890' | phoneFormat: { prefix: true, code: '+33', format: '(XXX) XXX-XXXX' } }} // <!-- +33 (123) 456-7890 -->
{{ '1234567890' | phoneFormat: { prefix: false, code: '+33', format: '(XXX) XXX-XXXX' } }} // <!-- (123) 456-7890 -->
{{ '1234567890' | phoneFormat: { prefix: false, format: '(XXX) XXX-XXXX' } }} // <!-- (123) 456-7890 -->

Setting up in `module's imports`

import {AngularPhoneHelperModule} from "angular-phone-helper";

// default country config
AngularPhoneHelperModule.forRoot({
  defaultCountryIsoCode: 'USA', // Country ISO code
  defaultWithCountryCode: false, // Add prefix by default
})

// custom country config
AngularPhoneHelperModule.forRoot({
  defaultWithCountryCode: true,
  customCountry: {
    isoCode: 'YOUR_CODE_3_LEN',
    isoCodeAlpha2: 'YOUR_CODE_2_LEN',
    name: 'YOUR_COUNTRY_NAME',
    phone: {
      codeDigit: '10',
      code: '+10',
      format: 'XXX XXX-XX-XX',
      formatInternational: 'XXX XXX-XX-XX',
    }
  }
}),

NOTE: Config is optional

NOTE: For custom country
Some countries have different format 
For example: France
codeDigit: "33", code: "+33", formatInternational: "X XX XX XX XX", format: "0X XX XX XX XX"
X - digits
0 - const

ApiConfig

| Key | Type | Optional | Default value | |---------------------------|----------------|-----------|---------------| | defaultCountryIsoCode | string | yes | | | defaultWithCountryCode | boolean | yes | true | | customCountry | CountryModel | yes | null |

CountryModel

| Key | Type | Optional | Default value | |---------------------------|-----------------|----------|---------------| | name | string | no | | | isoCode | string | no | | | isoCodeAlpha2 | string | no | | | phone | PhoneModel | no | |

PhoneModel

| Key | Type | Optional | Default value | |---------------------------|-----------------|----------|---------------| | code | string | no | | | codeDigit | string | no | | | format | string | no | | | formatInternational | string | yes | |

Usage `PhoneFormatService` in `ts`

import {PhoneFormatService} from "angular-phone-helper";

constructor(private readonly phoneFormatService: PhoneFormatService) {
  this.phoneFormatService.isCustomFormatted('123 456-78-90'); // true
  this.phoneFormatService.isInternationalFormatted('+3 123 456 7890'); // true
  this.phoneFormatService.isInternationalFormatted('+4811231234567890'); // false
  this.phoneFormatService.isInternationalFormatted('+481 2312 67890'); // false
  this.phoneFormatService.isUnitedStatesFormatted('(123) 456-7890'); // true
  this.phoneFormatService.isUnitedStatesFormatted('+1 (123) 456-7890'); // true
  this.phoneFormatService.isUnitedStatesFormatted('+2 (123) 456-7890'); // false
}

Usage `PhoneFormatPipe` in `ts`

import {countriesDictionary, PhoneFormatPipe} from "angular-phone-helper";

constructor(private readonly phoneFormatPipe: PhoneFormatPipe) {
  this.phoneFormatPipe.transform('31234567890'); // +3 123 456 7890
  this.phoneFormatPipe.transform('1234567890', { iso: 'USA', prefix: true }); // +1 (123) 456-7890
  this.phoneFormatPipe.transform('1234567890', { prefix: true }); // 1234567890 (wrong length)
  this.phoneFormatPipe.transform('1234567890', { iso: countriesDictionary.usa.isoCode }); // +1 (123) 456-7890
  this.phoneFormatPipe.transform('1234567890', { iso: countriesDictionary.usa.isoCode, prefix: false }) // (123) 456-7890
}

Usage `PhoneFormatPipe` in `html`

{{ '31234567890' | phoneFormat }} <!-- +3 123 456 7890 -->
{{ '1234567890' | phoneFormat: { iso: 'USA', prefix: true } }} // <!-- +1 (123) 456-7890 -->
{{ '41234567890' | phoneFormat: { prefix: true } }} // <!-- +4 123 456 7890 -->
{{ '1234567890' | phoneFormat: { prefix: true, code: '+33', format: '(XXX) XXX-XXXX' } }} // <!-- +33 (123) 456-7890 -->
{{ '1234567890' | phoneFormat: { prefix: false, code: '+33', format: '(XXX) XXX-XXXX' } }} // <!-- (123) 456-7890 -->
{{ '1234567890' | phoneFormat: { prefix: false, format: '(XXX) XXX-XXXX' } }} // <!-- (123) 456-7890 -->

Supported countries (in progress...)

NOTE: Methods in table and `custom country method`
Input >>> phone: string
Output >>> result: boolean

NOTE: isFormatted method
Input >>> phone: string, countryIsoCode: string
Output >>> result: boolean

| ID | Country ISO code | |-------|------------------|--------- | 1 | International | 2 | USA | 3 | CAN | 4 | GBR | 5 | FRA | 6 | DEU | 7 | ITA | 8 | POL | 9 | UKR | 10 | MDA | 11 | GRC | 12 | TUR | 13 | IND | 14 | CHN | 15 | IDN | 16 | PHL | 17 | AUS | 18 | BRA | 19 | ARG | 20 | MEX | 21 | ESP | 22 | CZE | 23 | PER | 24 | JPN | 25 | KOR | 26 | AUT | 27 | AZE | 28 | ALB | 29 | DZA | 30 | AGO | 31 | AND | 32 | ATG | 33 | ARM | 34 | AFG | 35 | UZB | 36 | YEM | 37 | KNA | 38 | BGD | 39 | BHS | 40 | BRB | 41 | BHR | 43 | BLZ | 44 | BEL | 45 | BEN | 46 | BGR | 47 | BOL | 48 | BIH | 49 | BWA | 50 | BRN | 51 | BFA | 52 | BDI | 53 | BTN | 54 | VUT | 55 | HUN | 56 | VEN | 57 | TLS | 58 | VNM | 59 | GAB | 60 | HTI | 61 | GUY | 62 | GMB | 63 | GHA | 64 | GTM | 65 | GIN | 66 | GNB | 67 | HND | 68 | GRD | 69 | GEO | 70 | DNK | 71 | DJI | 72 | DMA | 73 | DOM | 74 | EGY | 75 | ZMB | 76 | ZWE | 77 | ISR | 78 | CPV | 79 | KHM | 80 | CMR | 81 | CAF | 82 | TCD | 83 | CHL | 84 | COL | 85 | COM | 86 | COG | 87 | CRI | 88 | CIV | 89 | HRV | 90 | CUB | 91 | CYP | 92 | ECU | 93 | SLV | 94 | GNQ | 95 | EST | 96 | ETH | 97 | FJI | 98 | FIN | 99 | ISL | 100 | IRQ | 101 | IRL | 102 | JAM | 103 | JOR | 104 | KAZ | 105 | KEN | 106 | KIR | 107 | PRK | 108 | KWT | 109 | KGZ | 110 | LAO | 111 | LVA | 112 | LBN | 113 | LSO | 114 | LBR | 115 | LBY | 116 | LIE | 117 | LTU | 118 | LUX | 119 | MKD | 120 | MDG | 121 | MWI | 122 | MYS | 123 | MDV | 124 | MLT | 125 | MHL | 126 | MRT | 127 | MUS | 128 | FSM | 129 | MCO | 130 | MNG | 131 | MNE | 132 | MAR | 133 | MOZ | 134 | MMR | 135 | NAM | 136 | NRU | 137 | NPL | 138 | NLD | 139 | NZL | 140 | NER | 141 | NGA | 142 | NIU | 143 | NOR | 144 | OMN | 145 | PAK | 146 | PLW | 147 | PAN | 148 | PNG | 149 | PRY | 150 | PRT | 151 | QAT | 152 | ROU | 153 | RWA | 154 | WSM | 155 | SMR | 156 | STP | 157 | SAU | 158 | SEN | 159 | SRB | 160 | SYC | 161 | SLE | 162 | SGP | 163 | SVK | 164 | SVN | 165 | SLB | 166 | SOM | 167 | ZAF | 168 | SSD | 169 | LKA | 170 | SDN | 171 | SUR | 172 | SWZ | 173 | SWE | 174 | CHE | 175 | TWN | 176 | TJK | 177 | TZA | 178 | THA | 179 | TGO | 180 | TON | 181 | TTO | 182 | TUN | 183 | TKM | 184 | TUV | 185 | UGA | 186 | ARE | 187 | URY | 188 | VCT | 189 | LCA Phone prefix | Phone format | Method* | -----|-------------------|-------------------------------------------| | | +X XXX XXX XXXX | isInternationalFormatted | | +1 | (XXX) XXX-XXXX | isUnitedStatesFormatted | | +1 | (XXX) XXX-XXXX | isCanadaFormatted | | +44 | 0XX XXXX XXXX | isUnitedKingdomFormatted | | +33 | 0X XX XX XX XX | isFranceFormatted | | +49 | 0XXX XXXXXXX | isGermanyFormatted | | +39 | XXX XXX XXXX | isItalyFormatted | | +48 | XXX XXX XXX | isPolandFormatted | | +380 | XXX XXX XX XX | isUkraineFormatted | | +373 | XX XXX XXX | isMoldovaFormatted | | +30 | XXX XXX XXXX | isGreeceFormatted | | +90 | XXX XXX XXXX | isTurkeyFormatted | | +91 | XXXXX XXXXX | isIndiaFormatted | | +86 | XXX XXXX XXXX | isChinaFormatted | | +62 | XXXX-XXXX-XXXX | isIndonesiaFormatted | | +63 | XXX XXX XXXX | isPhilippinesFormatted | | +61 | XXXX XXX XXX | isAustraliaFormatted | | +55 | (XX) XXXX-XXXX | isBrazilFormatted | | +54 | XX XXXX-XXXX | isArgentinaFormatted | | +52 | XX XXXX XXXX | isMexicoFormatted | | +34 | XXX XX XX XX | isSpainFormatted | | +420 | XXX XXX XXX | isCzechRepublicFormatted | | +51 | XXX XXX XXX | isPeruFormatted | | +81 | XXX-XXXX-XXXX | isJapanFormatted | | +82 | XXX-XXX-XXXX | isSouthKoreaFormatted | | +43 | XX XXXXXXXXX | isAustriaFormatted | | +994 | XX XXXXX XXXX | isAzerbaijanFormatted | | +355 | XXX XX XX XXX | isAlbaniaFormatted | | +213 | XXX XX XX XX XX | isAlgeriaFormatted | | +244 | XXX XXX XXX | isAngolaFormatted | | +376 | XXXXXX | isAndorraFormatted | | +1268 | XXX XXXX | isAntiguaAndBarbudaFormatted | | +374 | XX XXXXXX | isArmeniaFormatted | | +93 | X XX XXX XXXX | isAfghanistanFormatted | | +998 | XX XXX XX XX | isUzbekistanFormatted | | +967 | X XXX XXX | isYemenFormatted | | +1869 | XXX-XXX-XXXX | isSaintKittsAndNevisFormatted | | +880 | 01XX XXX XXXX | isBangladeshFormatted | | +1-242 | (XXX) XXX-XXXX | isBahamasFormatted | | +1-246 | (XXX) XXX-XXXX | isBarbadosFormatted | | +973 | XXXX XXXX | isBahrainFormatted | | +501 | XXX-XXXX | isBelizeFormatted | | +32 | 0X XX XX XX XX | isBelgiumFormatted | | +229 | XX XX XX XX | isBeninFormatted | | +359 | X XXX XXXX | isBulgariaFormatted | | +591 | XXXX-XXXX | isBoliviaFormatted | | +387 | XXX XXX XXX | isBosniaAndHerzegovinaFormatted | | +267 | XX XXX XXX | isBotswanaFormatted | | +673 | XXXX XXX | isBruneiFormatted | | +226 | XX XX XXXX | isBurkinaFasoFormatted | | +257 | XX XX XXXX | isBurundiFormatted | | +975 | XX XX XXX | isBhutanFormatted | | +678 | XXX-XXXX | isVanuatuFormatted | | +36 | (XX) XXX-XXXX | isHungaryFormatted | | +58 | (XXX) XXX-XXXX | isVenezuelaFormatted | | +670 | XXX-XXXX | isEastTimorFormatted | | +84 | XXX XXX XXXX | isVietnamFormatted | | +241 | X XX XX XX | isGabonFormatted | | +509 | XXX XX-XXXX | isHaitiFormatted | | +592 | XXX XXXX | isGuyanaFormatted | | +220 | XXX XXXX | isGambiaFormatted | | +233 | XXX XXX XXXX | isGhanaFormatted | | +502 | XXXX XXXX | isGuatemalaFormatted | | +224 | XX XXX XXX | isGuineaFormatted | | +245 | X XXX XXXX | isGuineaBissauFormatted | | +504 | XXXX-XXXX | isHondurasFormatted | | +473 | XXX XXXX | isGrenadaFormatted | | +995 | XXX XX XX XX | isGeorgiaFormatted | | +45 | XX XX XX XX | isDenmarkFormatted | | +253 | XX XX XX XX | isDjiboutiFormatted | | +1 | (XXX) XXX-XXXX | isDominicaFormatted | | +1 | (XXX) XXX-XXXX | isDominicanRepublicFormatted | | +20 | 01X XXX XXXX | isEgyptFormatted | | +260 | XXX XXX XXX | isZambiaFormatted | | +263 | X XXX XXXX | isZimbabweFormatted | | +972 | XX-XXX-XXXX | isIsraelFormatted | | +238 | XXX-XX-XX | isCapeVerdeFormatted | | +855 | XX-XXX-XXX | isCambodiaFormatted | | +237 | XX-XX-XX-XX | isCameroonFormatted | | +236 | XX-XX-XX-XX | isCentralAfricanRepublicFormatted | | +235 | XX-XX-XX-XX | isChadFormatted | | +56 | XX-XXXX-XXXX | isChileFormatted | | +57 | XXX-XXX-XXXX | isColombiaFormatted | | +269 | XX-XX-XX | isComorosFormatted | | +242 | XXX-XX-XX-XXX | isCongoFormatted | | +506 | XXX-XXXX | isCostaRicaFormatted | | +225 | XX-XX-XX-XX | isIvoryCoastFormatted | | +385 | XXX-XXX-XXX | isCroatiaFormatted | | +53 | X-XXXXXX | isCubaFormatted | | +357 | XX-XXXXXX | isCyprusFormatted | | +593 | X-XXX-XXXX | isEcuadorFormatted | | +503 | XXXX-XXXX | isElSalvadorFormatted | | +240 | XXX-XXX-XXX | isEquatorialGuineaFormatted | | +372 | XXX XXXX | isEstoniaFormatted | | +251 | XX XXX XXXX | isEthiopiaFormatted | | +679 | X XXXXXX | isFijiFormatted | | +358 | XXX XXX XXXX | isFinlandFormatted | | +354 | XXX XXXX | isIcelandFormatted | | +964 | XXX XXX XXXX | isIraqFormatted | | +353 | XXX XXX XXXX | isIrelandFormatted | | +1 | (XXX) XXX-XXXX | isJamaicaFormatted | | +962 | X XXX XXXX | isJordanFormatted | | +7 | XXX-XXX-XXXX | isKazakhstanFormatted | | +254 | XXX-XXX-XXX | isKenyaFormatted | | +686 | XXX-XXX | isKiribatiFormatted | | +850 | XXX-XXX-XXXX | isNorthKoreaFormatted | | +965 | XXXX-XXXX | isKuwaitFormatted | | +996 | XXX-XXX-XXX | isKyrgyzstanFormatted | | +856 | XX-XXX-XXX | isLaosFormatted | | +371 | XXXX-XXXX | isLatviaFormatted | | +961 | XX-XXX-XXX | isLebanonFormatted | | +266 | XXX-XXXXX | isLesothoFormatted | | +231 | XXX-XXX-XXXX | isLiberiaFormatted | | +218 | XX-XXX-XXXX | isLibyaFormatted | | +423 | XXXXXXX | isLiechtensteinFormatted | | +370 | (X-XXXXX) | isLithuaniaFormatted | | +352 | XXXXXXX | isLuxembourgFormatted | | +389 | XXX-XXX-XX | isNorthMacedoniaFormatted | | +261 | XX-XX-XXX-XX | isMadagascarFormatted | | +265 | XXXXXXXXX | isMalawiFormatted | | +60 | XX-XXXX-XXXX | isMalaysiaFormatted | | +960 | XXXXXXX | isMaldivesFormatted | | +356 | XX-XX-XX-XX | isMaltaFormatted | | +692 | XXX-XXXX | isMarshallIslandsFormatted | | +222 | XX-XX-XX-XX | isMauritaniaFormatted | | +230 | XXXX-XXXX | isMauritiusFormatted | | +691 | XXX-XXXX | isMicronesiaFederatedStatesOfFormatted | | +377 | XX-XX-XX-XX-XX | isMonacoFormatted | | +976 | XX-XX-XXXX | isMongoliaFormatted | | +382 | XX-XXX-XXX | isMontenegroFormatted | | +212 | XX-XX-XX-XX-XX | isMoroccoFormatted | | +258 | XX-XXX-XXXX | isMozambiqueFormatted | | +95 | XX-XXX-XXX | isMyanmarFormatted | | +264 | XXX-XXXXXX | isNamibiaFormatted | | +674 | XXX-XXXX | isNauruFormatted | | +977 | XXX-XXXXXXX | isNepalFormatted | | +31 | X-XXXXXX | isNetherlandsFormatted | | +64 | XX-XXXX-XXXX | isNewZealandFormatted | | +227 | XX-XX-XXXX | isNigerFormatted | | +234 | XXX-XXX-XXXX | isNigeriaFormatted | | +683 | XXXX | isNiueFormatted | | +47 | XXXX-XXXX | isNorwayFormatted | | +968 | XXX-XXXX-XXXX | isOmanFormatted | | +92 | XXX XXXXXXX | isPakistanFormatted | | +680 | XXX-XXXX | isPalauFormatted | | +507 | XXX-XXXX-XXXX | isPanamaFormatted | | +675 | XXXX-XXX | isPapuaNewGuineaFormatted | | +595 | XXX-XXXXXX | isParaguayFormatted | | +351 | XXX XXX XXX | isPortugalFormatted | | +974 | XXX-XXXX-XXXX | isQatarFormatted | | +40 | 0XX XXX XXX | isRomaniaFormatted | | +250 | XXX XXX XXXX | isRwandaFormatted | | +685 | XX XXXX | isSamoaFormatted | | +378 | XXX XXXXXX | isSanMarinoFormatted | | +239 | 9XXX-XXXX | isSaoTomeAndPrincipeFormatted | | +966 | XXX XXX XXXX | isSaudiArabiaFormatted | | +221 | XX XXX XX XX | isSenegalFormatted | | +381 | XX XXXXXXX | isSerbiaFormatted | | +248 | X XX XX XX | isSeychellesFormatted | | +232 | (XXX) XXX XXXX | isSierraLeoneFormatted | | +65 | XXXX XXXX | isSingaporeFormatted | | +421 | XXX/XXX XXX | isSlovakiaFormatted | | +386 | 0X XXX XX XX | isSloveniaFormatted | | +677 | XXX XXXX | isSolomonIslandsFormatted | | +252 | XX-XXX-XXXX | isSomaliaFormatted | | +27 | XXX XXX XXXX | isSouthAfricaFormatted | | +211 | XX XXX XXXX | isSouthSudanFormatted | | +94 | XX XXX XXXX | isSriLankaFormatted | | +249 | XXX XXX XXXX | isSudanFormatted | | +597 | XXX-XXXX | isSurinameFormatted | | +268 | XXX XXXX | isEswatiniFormatted | | +46 | XXX-XXX XX XX | isSwedenFormatted | | +41 | 0XX XXX XX XX | isSwitzerlandFormatted | | +886 | XXX-XXXXXX | isTaiwanFormatted | | +992 | XXX-XX-XX-XX | isTajikistanFormatted | | +255 | XXX-XXX-XXXX | isTanzania,UnitedRepublicOfFormatted | | +66 | XXX-XXXX-XXXX | isThailandFormatted | | +228 | XX-XX-XXXX | isTogoFormatted | | +676 | XXX-XXXX | isTongaFormatted | | +1868 | XXX-XXXX | isTrinidadAndTobagoFormatted | | +216 | XX-XXX-XXX | isTunisiaFormatted | | +993 | XX-XX-XX-XX-XX | isTurkmenistanFormatted | | +688 | XXX-XXXX | isTuvaluFormatted | | +256 | XX XXX XXXX | isUgandaFormatted | | +971 | XXXX XXX XXXX | isUnitedArabEmiratesFormatted | | +598 | X XXX XXXX | isUruguayFormatted | | +1784 | XXX-XXXX | isSaintVincentAndtheGrenadinesFormatted | | +1758 | XXX-XXXX | isSaintLuciaFormatted |

Examples

| Phone | Formatted Phone | Description | |---------------------|---------------------|--------------------------------| | +1234567890 | +1 (123) 456-7890 | USA with prefix | | 123456789 | 123456789 | USA with prefix (wrong length) | | (123) 456-7890 | +1 (123) 456-7890 | USA with prefix | | +1 (123) 456-7890 | +1 (123) 456-7890 | USA with prefix | | 1234567890 | +1 (123) 456-7890 | USA with prefix | | 1234567890 | +1 (123) 456-7890 | USA with prefix | | 1234567890 | (123) 456-7890 | USA without prefix |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme