📮 @worldkit/postal

Postal code regex pattern matching and ZIP code validation library for JavaScript & TypeScript.

Retrieve country-specific postal code regex patterns and validate ZIP codes worldwide.

📚 Full Documentation: https://worldkit.in/docs/postal

⚡ Features

• 📮 Global Postal Patterns: Regex rules for US ZIP, UK Postcodes, Canadian Postal Codes, Indian PIN codes, etc.
• 🛡️ Instant Validation: Validate customer address postal codes on front-end forms or back-end APIs.
• 📦 Micro Size: ~1.2 KB gzipped.

📦 Install

npm install @worldkit/postal
# or
pnpm add @worldkit/postal
# or
yarn add @worldkit/postal

💡 Usage

import { postalRegex, validatePostalCode } from "@worldkit/postal";

// 1. Get Postal Code Regex Pattern for a Country ISO2
console.log(postalRegex("US")); // "^\d{5}(-\d{4})?$"
console.log(postalRegex("IN")); // "^\d{6}$"
console.log(postalRegex("GB")); // "^[A-Z]{1,2}\d[A-Z\d]? \d[A-Z]{2}$"

// 2. Validate Postal Codes
console.log(validatePostalCode("US", "90210"));      // true
console.log(validatePostalCode("US", "90210-1234")); // true
console.log(validatePostalCode("IN", "400001"));     // true
console.log(validatePostalCode("IN", "ABCDE"));      // false

📖 API Reference

postalRegex(countryIso2: string): string

Returns the regular expression string pattern for postal code validation in that country.

validatePostalCode(countryIso2: string, postalCode: string): boolean

Validates whether a given postal code string satisfies country postal formatting rules.

📐 TypeScript Support

Includes strict TypeScript declarations.

🔗 Related Packages

Explore the rest of the WorldKit ecosystem:

• @worldkit/core - Unified global data facade.
• @worldkit/countries - 250+ country dataset.
• @worldkit/validators - Phone, EU VAT & Postal code validators.
• @worldkit/formatters - Address & phone formatters.

📜 License

MIT © WorldKit