Postal Code Formats by Country

import { postalCode } from '@koshmoney/countries';
 
// Validate any postal code
postalCode.isValid('US', '90210');       // true
postalCode.isValid('GB', 'SW1A 1AA');   // true
postalCode.isValid('JP', '100-0001');   // true
 
// Get local terminology
postalCode.getName('US');  // 'ZIP Code'
postalCode.getName('IN');  // 'PIN Code'
postalCode.getName('DE');  // 'PLZ'
 
// Get format description
postalCode.getFormat('US');  // 'NNNNN or NNNNN-NNNN'
postalCode.getFormat('CA');  // 'A1A 1A1'
postalCode.getFormat('GB');  // 'AA9A 9AA'
 
// Check if country uses postal codes
postalCode.hasPostalCode('US');  // true
postalCode.hasPostalCode('HK');  // false

import { postalCode } from '@koshmoney/countries';
 
postalCode.hasPostalCode('HK');  // false (Hong Kong)
postalCode.hasPostalCode('AE');  // false (UAE)
postalCode.hasPostalCode('QA');  // false (Qatar)
postalCode.hasPostalCode('PA');  // false (Panama)

import { postalCode, country } from '@koshmoney/countries';
 
// Build a postal code format reference for all countries
const allCountries = country.all();
 
for (const c of allCountries) {
  if (postalCode.hasPostalCode(c.alpha2)) {
    const name = postalCode.getName(c.alpha2);
    const format = postalCode.getFormat(c.alpha2);
    console.log(`${c.name} (${c.alpha2}): ${name} - ${format}`);
  }
}
// Afghanistan (AF): Postal code - NNNN
// Albania (AL): Kodi postar - NNNN
// ...

import { postalCode } from '@koshmoney/countries';
 
function getPostalCodeLabel(countryCode: string): {
  label: string;
  placeholder: string;
  required: boolean;
} {
  const has = postalCode.hasPostalCode(countryCode);
  return {
    label: postalCode.getName(countryCode) || 'Postal Code',
    placeholder: postalCode.getFormat(countryCode) || '',
    required: has,
  };
}
 
getPostalCodeLabel('US');
// { label: 'ZIP Code', placeholder: 'NNNNN or NNNNN-NNNN', required: true }
 
getPostalCodeLabel('DE');
// { label: 'PLZ', placeholder: 'NNNNN', required: true }
 
getPostalCodeLabel('HK');
// { label: 'Postal Code', placeholder: '', required: false }