isPostalCode Function Documentation

The isPostalCode function checks if the input value represents a valid postal code for supported countries. It returns true if the value matches the postal code format for any of the supported countries, and false otherwise.

Import

The function can be imported using ES6 syntax from the "multiform-validator" package:

import { isPostalCode } from 'multiform-validator';

Alternatively, you can import the function using CommonJS syntax with require (Node.js):

const { isPostalCode } = require('multiform-validator');

Parameters

The function takes one parameter, which must be a string representing the postal code to be checked.

• postalCode (string) - The postal code to be checked for validity.

Supported Countries

The function supports postal codes for the following countries:

• United States of America
• Canada
• United Kingdom
• France
• Netherlands
• Japan
• Spain
• South Africa
• Germany
• Switzerland
• Brazil
• Italy

Examples

// Example 1 - Valid postal codes
const result1 = isPostalCode('12345'); // true (United States)
console.log(result1);

const result2 = isPostalCode('M4B 1B3'); // true (Canada)
console.log(result2);

const result3 = isPostalCode('SW1A 1AA'); // true (United Kingdom)
console.log(result3);

const result4 = isPostalCode('75013'); // true (France)
console.log(result4);

const result5 = isPostalCode('1012'); // true (Netherlands)
console.log(result5);

const result6 = isPostalCode('100-0001'); // true (Japan)
console.log(result6);

// Example 2 - Invalid postal codes
const result7 = isPostalCode('28001'); // true (Spain)
console.log(result7);

const result8 = isPostalCode('8000'); // true (South Africa)
console.log(result8);

const result9 = isPostalCode('13355'); // true (Germany)
console.log(result9);

const result10 = isPostalCode('1002'); // true (Switzerland)
console.log(result10);

const result11 = isPostalCode('10045-123'); // true (Brazil)
console.log(result11);

const result12 = isPostalCode('00100'); // true (Italy)
console.log(result12);

const result13 = isPostalCode('90210'); // true (United States ZIP Code)
console.log(result13);

// Example 3 - Not a valid postal code
const result14 = isPostalCode('Hello'); // false (not a valid postal code)
console.log(result14);

Notes

The function uses regular expressions to check the input postal code against supported 'countries' postal code formats. It returns true if the input value matches any of the supported postal code formats, and false otherwise.